Skip to content

Commit 47145e7

Browse files
committed
Update KDoc and changelog entry
1 parent 9a1007a commit 47145e7

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

firebase-vertexai/CHANGELOG.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
# Unreleased
22
* [changed] Added new exception type for quota exceeded scenarios.
33
* [feature] `CountTokenRequest` now includes `GenerationConfig` from the model.
4-
* [changed] `ImagenInlineImage.data` is now returned as binary instead of base64. (#6800)
4+
* [changed] **Breaking Change**: `ImagenInlineImage.data` now returns the raw
5+
image bytes (in JPEG or PNG format, specified in `ImagenInlineImage.mimeType`)
6+
instead of Base64-encoded data. (#6800)
7+
* **Action Required:** Remove any Base64 decoding from your
8+
`ImagenInlineImage.data` usage.
9+
* The `asBitmap()` helper method is unaffected and requires no code changes.
510

611
# 16.2.0
712
* [fixed] Added support for new values sent by the server for `FinishReason` and `BlockReason`.

firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.kt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,11 @@ import android.graphics.Bitmap
2020
import android.graphics.BitmapFactory
2121

2222
/**
23-
* Represents an Imagen-generated image that is contained inline
23+
* Represents an Imagen-generated image that is returned as inline data.
2424
*
25-
* @param data Contains the raw bytes of the image
26-
* @param mimeType Contains the MIME type of the image (for example, `"image/png"`)
25+
* @property data The raw image bytes in JPEG or PNG format, as specified by [mimeType].
26+
* @property mimeType The IANA standard MIME type of the image data; either `"image/png"` or
27+
* `"image/jpeg"`; to request a different format, see [ImagenGenerationConfig.imageFormat].
2728
*/
2829
@PublicPreviewAPI
2930
public class ImagenInlineImage

0 commit comments

Comments
 (0)