[Vertex AI] Return ImagenInlineImage.data as binary
#6800
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Javadoc Changes:--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenInlineImage.html 2025-03-25 17:33:46.710833161 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenInlineImage.html 2025-03-25 17:31:37.539602546 +0000
@@ -11,7 +11,7 @@
<pre>@<a href="/docs/reference/android/com/google/firebase/vertexai/type/PublicPreviewAPI.html">PublicPreviewAPI</a><br>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenInlineImage.html">ImagenInlineImage</a></pre>
</p>
<hr>
- <p>Represents an Imagen-generated image that is contained inline</p>
+ <p>Represents an Imagen-generated image that is returned as inline data.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -29,14 +29,14 @@
<td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> byte[]</code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenInlineImage.html#data()">data</a></code></div>
- <p>Contains the raw bytes of the image</p>
+ <p>The raw image bytes in JPEG or PNG format, as specified by <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenInlineImage.html#mimeType()">mimeType</a></code>.</p>
</td>
</tr>
<tr>
<td><code>final @<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></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenInlineImage.html#mimeType()">mimeType</a></code></div>
- <p>Contains the MIME type of the image (for example, <code>"image/png"</code>)</p>
+ <p>The IANA standard MIME type of the image data; either <code>"image/png"</code> or <code>"image/jpeg"</code>; to request a different format, see <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#imageFormat()">ImagenGenerationConfig.imageFormat</a></code>.</p>
</td>
</tr>
</tbody>
@@ -69,12 +69,12 @@
<div class="api-item"><a name="getData()"></a><a name="setData()"></a><a name="getData--"></a><a name="setData--"></a>
<h3 class="api-name" id="data()">data</h3>
<pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> byte[] <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenInlineImage.html#data()">data</a></pre>
- <p>Contains the raw bytes of the image</p>
+ <p>The raw image bytes in JPEG or PNG format, as specified by <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenInlineImage.html#mimeType()">mimeType</a></code>.</p>
</div>
<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 final @<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> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenInlineImage.html#mimeType()">mimeType</a></pre>
- <p>Contains the MIME type of the image (for example, <code>"image/png"</code>)</p>
+ <p>The IANA standard MIME type of the image data; either <code>"image/png"</code> or <code>"image/jpeg"</code>; to request a different format, see <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#imageFormat()">ImagenGenerationConfig.imageFormat</a></code>.</p>
</div>
</div>
<div class="list">--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/package-summary.html 2025-03-25 17:33:46.711833163 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/package-summary.html 2025-03-25 17:31:37.541602549 +0000
@@ -227,7 +227,7 @@
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenInlineImage.html">ImagenInlineImage</a></code></td>
<td>
- <p>Represents an Imagen-generated image that is contained inline</p>
+ <p>Represents an Imagen-generated image that is returned as inline data.</p>
</td>
</tr>
<tr>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html 2025-03-25 17:33:46.702833147 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html 2025-03-25 17:31:37.529602528 +0000
@@ -11,7 +11,7 @@
<pre>@<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/PublicPreviewAPI.html">PublicPreviewAPI</a><br>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html">ImagenInlineImage</a></pre>
</p>
<hr>
- <p>Represents an Imagen-generated image that is contained inline</p>
+ <p>Represents an Imagen-generated image that is returned as inline data.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -51,14 +51,14 @@
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html#data()">data</a></code></div>
- <p>Contains the raw bytes of the image</p>
+ <p>The raw image bytes in JPEG or PNG format, as specified by <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html#mimeType()">mimeType</a></code>.</p>
</td>
</tr>
<tr>
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html#mimeType()">mimeType</a></code></div>
- <p>Contains the MIME type of the image (for example, <code>"image/png"</code>)</p>
+ <p>The IANA standard MIME type of the image data; either <code>"image/png"</code> or <code>"image/jpeg"</code>; to request a different format, see <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#imageFormat()">ImagenGenerationConfig.imageFormat</a></code>.</p>
</td>
</tr>
</tbody>
@@ -77,12 +77,12 @@
<div class="api-item"><a name="getData()"></a><a name="setData()"></a><a name="getData--"></a><a name="setData--"></a>
<h3 class="api-name" id="data()">data</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html#data()">data</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a></pre>
- <p>Contains the raw bytes of the image</p>
+ <p>The raw image bytes in JPEG or PNG format, as specified by <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html#mimeType()">mimeType</a></code>.</p>
</div>
<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 <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html#mimeType()">mimeType</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></pre>
- <p>Contains the MIME type of the image (for example, <code>"image/png"</code>)</p>
+ <p>The IANA standard MIME type of the image data; either <code>"image/png"</code> or <code>"image/jpeg"</code>; to request a different format, see <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#imageFormat()">ImagenGenerationConfig.imageFormat</a></code>.</p>
</div>
</div>
</body>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/package-summary.html 2025-03-25 17:33:46.703833148 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/package-summary.html 2025-03-25 17:31:37.530602530 +0000
@@ -200,7 +200,7 @@
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html">ImagenInlineImage</a></code></td>
<td>
- <p>Represents an Imagen-generated image that is contained inline</p>
+ <p>Represents an Imagen-generated image that is returned as inline data.</p>
</td>
</tr>
<tr> |
Test Results 18 files - 1 016 18 suites - 1 016 12s ⏱️ - 34m 19s Results for commit 362ec20. ± Comparison against base commit baa335c. This pull request removes 5786 tests.♻️ This comment has been updated with latest results. |
Size Report 1Affected Products
Test Logs |
|
The public api surface has changed for the subproject firebase-dataconnect_api.txt: Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly. |
andrewheard
requested review from
davidmotson,
rachelsaunders,
thatfiredev and
rlazo
rlazo
approved these changes
Mar 25, 2025
|
The public api surface has changed for the subproject firebase-dataconnect_api.txt: Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly. |
rachelsaunders
approved these changes
Mar 25, 2025
davidmotson
approved these changes
Mar 25, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated
ImagenGenerationResponseto decode the base64-encoded image data from the backend when creating a publicImagenInlineImage. TheImagenInlineImage.datanow returns the rawimage bytes (in JPEG or PNG format, specified in
ImagenInlineImage.mimeType), still as aByteArray, instead of Base64-encoded data. See firebase/firebase-ios-sdk#14603 (comment) for the iOS-equivalent discussion, as well as #6786. This makes Android implementation consistent with the Swift SDK.