Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change InlineDataPart to match ImagePart #6346

Merged
merged 1 commit into from
Oct 4, 2024
Merged

Conversation

rlazo
Copy link
Collaborator

@rlazo rlazo commented Oct 3, 2024

The order of the parameters should be consistent between them, and it should be (url/byte, mime-type).

The order of the parameters should be consistent between them, and it
should be (url/byte, mime-type).
Copy link
Contributor

github-actions bot commented Oct 3, 2024

Javadoc Changes:
--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/InlineDataPart.html	2024-10-03 21:50:21.636682731 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/InlineDataPart.html	2024-10-03 21:48:15.115852396 +0000
@@ -56,7 +56,7 @@
         <tbody class="list">
           <tr>
             <td>
-              <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/InlineDataPart.html#InlineDataPart(kotlin.String,kotlin.ByteArray)">InlineDataPart</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>&nbsp;mimeType,&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> byte[]&nbsp;inlineData)</code></div>
+              <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/InlineDataPart.html#InlineDataPart(kotlin.ByteArray,kotlin.String)">InlineDataPart</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> byte[]&nbsp;inlineData,&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>&nbsp;mimeType)</code></div>
             </td>
           </tr>
         </tbody>
@@ -72,14 +72,14 @@
       <div class="api-item"><a name="getMimeType()"></a><a name="setMimeType()"></a><a name="getMimeType--"></a><a name="setMimeType--"></a>
         <h3 class="api-name" id="mimeType()">mimeType</h3>
         <pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>&nbsp;<a href="/docs/reference/android/com/google/firebase/vertexai/type/InlineDataPart.html#mimeType()">mimeType</a></pre>
-        <p>an IANA standard MIME type. For supported values, see the <a href="https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/send-multimodal-prompts#media_requirements">Vertex AI documentation</a> .</p>
+        <p>an IANA standard MIME type. For supported values, see the <a href="https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/send-multimodal-prompts#media_requirements">Vertex AI documentation</a></p>
       </div>
     </div>
     <div class="list">
       <h2>Public constructors</h2>
-      <div class="api-item"><a name="InlineDataPart(kotlin.String, kotlin.ByteArray)"></a><a name="InlineDataPart-kotlin.String-kotlin.ByteArray-"></a><a name="inlinedatapart"></a>
-        <h3 class="api-name" id="InlineDataPart(kotlin.String,kotlin.ByteArray)">InlineDataPart</h3>
-        <pre class="api-signature no-pretty-print">public&nbsp;<a href="/docs/reference/android/com/google/firebase/vertexai/type/InlineDataPart.html#InlineDataPart(kotlin.String,kotlin.ByteArray)">InlineDataPart</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>&nbsp;mimeType,&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> byte[]&nbsp;inlineData)</pre>
+      <div class="api-item"><a name="InlineDataPart(kotlin.ByteArray, kotlin.String)"></a><a name="InlineDataPart-kotlin.ByteArray-kotlin.String-"></a><a name="inlinedatapart"></a>
+        <h3 class="api-name" id="InlineDataPart(kotlin.ByteArray,kotlin.String)">InlineDataPart</h3>
+        <pre class="api-signature no-pretty-print">public&nbsp;<a href="/docs/reference/android/com/google/firebase/vertexai/type/InlineDataPart.html#InlineDataPart(kotlin.ByteArray,kotlin.String)">InlineDataPart</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> byte[]&nbsp;inlineData,&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>&nbsp;mimeType)</pre>
         <div class="devsite-table-wrapper">
           <table class="responsive">
             <colgroup>
@@ -93,15 +93,15 @@
             </thead>
             <tbody class="list">
               <tr>
-                <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>&nbsp;mimeType</code></td>
+                <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> byte[]&nbsp;inlineData</code></td>
                 <td>
-                  <p>an IANA standard MIME type. For supported values, see the <a href="https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/send-multimodal-prompts#media_requirements">Vertex AI documentation</a> .</p>
+                  <p>the binary data as a <code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a></code></p>
                 </td>
               </tr>
               <tr>
-                <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> byte[]&nbsp;inlineData</code></td>
+                <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>&nbsp;mimeType</code></td>
                 <td>
-                  <p>the binary data as a <code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a></code></p>
+                  <p>an IANA standard MIME type. For supported values, see the <a href="https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/send-multimodal-prompts#media_requirements">Vertex AI documentation</a></p>
                 </td>
               </tr>
             </tbody>
--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/InlineDataPart.html	2024-10-03 21:50:21.630682740 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/InlineDataPart.html	2024-10-03 21:48:15.106852409 +0000
@@ -27,7 +27,7 @@
         <tbody class="list">
           <tr>
             <td>
-              <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/InlineDataPart.html#InlineDataPart(kotlin.String,kotlin.ByteArray)">InlineDataPart</a>(mimeType:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>,&nbsp;inlineData:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a>)</code></div>
+              <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/InlineDataPart.html#InlineDataPart(kotlin.ByteArray,kotlin.String)">InlineDataPart</a>(inlineData:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a>,&nbsp;mimeType:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
             </td>
           </tr>
         </tbody>
@@ -64,9 +64,9 @@
     </div>
     <div class="list">
       <h2>Public constructors</h2>
-      <div class="api-item"><a name="InlineDataPart(kotlin.String, kotlin.ByteArray)"></a><a name="InlineDataPart-kotlin.String-kotlin.ByteArray-"></a><a name="inlinedatapart"></a>
-        <h3 class="api-name" id="InlineDataPart(kotlin.String,kotlin.ByteArray)">InlineDataPart</h3>
-        <pre class="api-signature no-pretty-print"><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/InlineDataPart.html#InlineDataPart(kotlin.String,kotlin.ByteArray)">InlineDataPart</a>(mimeType:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>,&nbsp;inlineData:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a>)</pre>
+      <div class="api-item"><a name="InlineDataPart(kotlin.ByteArray, kotlin.String)"></a><a name="InlineDataPart-kotlin.ByteArray-kotlin.String-"></a><a name="inlinedatapart"></a>
+        <h3 class="api-name" id="InlineDataPart(kotlin.ByteArray,kotlin.String)">InlineDataPart</h3>
+        <pre class="api-signature no-pretty-print"><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/InlineDataPart.html#InlineDataPart(kotlin.ByteArray,kotlin.String)">InlineDataPart</a>(inlineData:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a>,&nbsp;mimeType:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</pre>
         <div class="devsite-table-wrapper">
           <table class="responsive">
             <colgroup>
@@ -80,15 +80,15 @@
             </thead>
             <tbody class="list">
               <tr>
-                <td><code>mimeType:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
+                <td><code>inlineData:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a></code></td>
                 <td>
-                  <p>an IANA standard MIME type. For supported values, see the <a href="https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/send-multimodal-prompts#media_requirements">Vertex AI documentation</a> .</p>
+                  <p>the binary data as a <code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a></code></p>
                 </td>
               </tr>
               <tr>
-                <td><code>inlineData:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a></code></td>
+                <td><code>mimeType:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
                 <td>
-                  <p>the binary data as a <code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a></code></p>
+                  <p>an IANA standard MIME type. For supported values, see the <a href="https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/send-multimodal-prompts#media_requirements">Vertex AI documentation</a></p>
                 </td>
               </tr>
             </tbody>
@@ -106,7 +106,7 @@
       <div class="api-item"><a name="getMimeType()"></a><a name="setMimeType()"></a><a name="getMimeType--"></a><a name="setMimeType--"></a>
         <h3 class="api-name" id="mimeType()">mimeType</h3>
         <pre class="api-signature no-pretty-print">val&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/InlineDataPart.html#mimeType()">mimeType</a>:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></pre>
-        <p>an IANA standard MIME type. For supported values, see the <a href="https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/send-multimodal-prompts#media_requirements">Vertex AI documentation</a> .</p>
+        <p>an IANA standard MIME type. For supported values, see the <a href="https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/send-multimodal-prompts#media_requirements">Vertex AI documentation</a></p>
       </div>
     </div>
   </body>

@google-oss-bot
Copy link
Contributor

1 Warning
⚠️ Did you forget to add a changelog entry? (Add the 'no-changelog' label to the PR to silence this warning.)

Generated by 🚫 Danger

@rlazo rlazo added this to the vertexai-ga milestone Oct 3, 2024
Copy link
Contributor

github-actions bot commented Oct 3, 2024

Test Results

 16 files   -  1 002   16 suites   - 1 002   15s ⏱️ - 36m 48s
108 tests  -  5 697  108 ✅  -  5 675  0 💤  - 22  0 ❌ ±0 
216 runs   - 11 479  216 ✅  - 11 435  0 💤  - 44  0 ❌ ±0 

Results for commit f6349cd. ± Comparison against base commit 13ef861.

This pull request removes 5697 tests.
com.google.android.datatransport.cct.CctBackendFactoryTest ‑ create_returnCCTBackend_WhenBackendNameIsCCT
com.google.android.datatransport.cct.CctDestinationTest ‑ cctDestination_shouldOnlySupportProtoAndJson
com.google.android.datatransport.cct.CctDestinationTest ‑ cctDestination_shouldSupportProtoAndJson
com.google.android.datatransport.cct.CctTransportBackendTest ‑ decorate_whenOffline_shouldProperlyPopulateNetworkInfo
com.google.android.datatransport.cct.CctTransportBackendTest ‑ decorate_whenOnline_shouldProperlyPopulateNetworkInfo
com.google.android.datatransport.cct.CctTransportBackendTest ‑ schedule_shouldAddCookieOnPseudonymousIds
com.google.android.datatransport.cct.CctTransportBackendTest ‑ schedule_shouldDropCookieOnMixedPseudonymousIds
com.google.android.datatransport.cct.CctTransportBackendTest ‑ send_CompressedResponseIsUncompressed
com.google.android.datatransport.cct.CctTransportBackendTest ‑ send_whenBackendRedirectsMoreThan5Times_shouldOnlyRedirect4Times
com.google.android.datatransport.cct.CctTransportBackendTest ‑ send_whenBackendRedirects_shouldCorrectlyFollowTheRedirectViaPost
…

@rlazo rlazo merged commit 448adae into main Oct 4, 2024
29 checks passed
@rlazo rlazo deleted the rl.mime.type.consistency branch October 4, 2024 20:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants