docs: explicitly call out that ImagenInlineImage#data is base64 encoded #6785
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-20 14:36:38.017667114 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenInlineImage.html 2025-03-20 14:34:26.754044290 +0000
@@ -29,7 +29,7 @@
<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>Contains the base64-encoded image data.</p>
</td>
</tr>
<tr>
@@ -69,7 +69,7 @@
<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>Contains the base64-encoded image data.</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>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html 2025-03-20 14:36:38.006667132 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html 2025-03-20 14:34:26.744044335 +0000
@@ -51,7 +51,7 @@
<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>Contains the base64-encoded image data.</p>
</td>
</tr>
<tr>
@@ -77,7 +77,7 @@
<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>Contains the base64-encoded image data.</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> |
Generated by 🚫 Danger |
rachelsaunders
requested changes
Mar 20, 2025
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.kt
Outdated
Show resolved
Hide resolved
Coverage Report 1Affected ProductsNo changes between base commit (60a021d) and merge commit (9f906fd).Test Logs |
Co-authored-by: rachelsaunders <52258509+rachelsaunders@users.noreply.github.com>
Test Results 18 files - 1 014 18 suites - 1 014 13s ⏱️ - 33m 56s Results for commit dbbc34f. ± Comparison against base commit 60a021d. This pull request removes 5776 tests. |
Size Report 1Affected ProductsNo changes between base commit (60a021d) and merge commit (9f906fd).Test Logs |
rachelsaunders
approved these changes
Mar 20, 2025
|
Before we merge this, I think it would be ideal to determine if Going from the other direction (encoding), we don't ask devs to pass in base64-encoded data when using Gemini: Internally we encode it as base64 for them: If we are allowed to during Public Preview (cc: @rlazo for advice), IMHO, it would be ideal to decode the base64 for devs and to return a binary |
|
We have discussed this internally and decided to return the decoded inline image - that was the intended behavior all along. (returning the encoded base64 image was an oversight at first launch) Closing this PR in favor of #6800. |
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.
This is meant to match the JS ref docs.
See context in #6786