-
Notifications
You must be signed in to change notification settings - Fork 586
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
Add documentation to imagen #6616
Open
davidmotson
wants to merge
2
commits into
davidmotson.imagen_support
Choose a base branch
from
davidmotson.imagen_docs
base: davidmotson.imagen_support
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
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
Vertex AI Mock Responses Check
|
Generated by 🚫 Danger |
Javadoc Changes:--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/FirebaseVertexAI.html 2025-01-07 19:39:03.932824595 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/FirebaseVertexAI.html 2025-01-07 19:36:54.719326171 +0000
@@ -91,6 +91,7 @@
<td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/ImageModel.html">ImageModel</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/FirebaseVertexAI.html#imageModel(kotlin.String,com.google.firebase.vertexai.type.ImagenModelConfig,com.google.firebase.vertexai.type.ImageSafetySettings,com.google.firebase.vertexai.type.RequestOptions)">imageModel</a>(<br> @<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> modelName,<br> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenModelConfig.html">ImagenModelConfig</a> generationConfig,<br> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImageSafetySettings.html">ImageSafetySettings</a> safetySettings,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/RequestOptions.html">RequestOptions</a> requestOptions<br>)</code></div>
+ <p>Instantiates a new <code><a href="/docs/reference/android/com/google/firebase/vertexai/ImageModel.html">ImageModel</a></code> given the provided parameters.</p>
</td>
</tr>
</tbody>
@@ -222,6 +223,67 @@
<div class="api-item"><a name="imageModel(kotlin.String, com.google.firebase.vertexai.type.ImagenModelConfig, com.google.firebase.vertexai.type.ImageSafetySettings, com.google.firebase.vertexai.type.RequestOptions)"></a><a name="imageModel-kotlin.String-com.google.firebase.vertexai.type.ImagenModelConfig-com.google.firebase.vertexai.type.ImageSafetySettings-com.google.firebase.vertexai.type.RequestOptions-"></a><a name="imagemodel"></a>
<h3 class="api-name" id="imageModel(kotlin.String,com.google.firebase.vertexai.type.ImagenModelConfig,com.google.firebase.vertexai.type.ImageSafetySettings,com.google.firebase.vertexai.type.RequestOptions)">imageModel</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="/docs/reference/android/com/google/firebase/vertexai/ImageModel.html">ImageModel</a> <a href="/docs/reference/android/com/google/firebase/vertexai/FirebaseVertexAI.html#imageModel(kotlin.String,com.google.firebase.vertexai.type.ImagenModelConfig,com.google.firebase.vertexai.type.ImageSafetySettings,com.google.firebase.vertexai.type.RequestOptions)">imageModel</a>(<br> @<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> modelName,<br> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenModelConfig.html">ImagenModelConfig</a> generationConfig,<br> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImageSafetySettings.html">ImageSafetySettings</a> safetySettings,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/RequestOptions.html">RequestOptions</a> requestOptions<br>)</pre>
+ <p>Instantiates a new <code><a href="/docs/reference/android/com/google/firebase/vertexai/ImageModel.html">ImageModel</a></code> given the provided parameters.</p>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Parameters</th>
+ </tr>
+ </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> modelName</code></td>
+ <td>
+ <p>The name of the model to use, for example <code>"imagen-3.0-generate-001"</code>.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenModelConfig.html">ImagenModelConfig</a> generationConfig</code></td>
+ <td>
+ <p>The configuration parameters to use for image generation.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImageSafetySettings.html">ImageSafetySettings</a> safetySettings</code></td>
+ <td>
+ <p>The safety bounds the model will abide to during image generation.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/RequestOptions.html">RequestOptions</a> requestOptions</code></td>
+ <td>
+ <p>Configuration options for sending requests to the backend.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Returns</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/ImageModel.html">ImageModel</a></code></td>
+ <td>
+ <p>The initialized <code><a href="/docs/reference/android/com/google/firebase/vertexai/ImageModel.html">ImageModel</a></code> instance.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/ImageModel.html 2025-01-07 19:39:03.932824595 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/ImageModel.html 2025-01-07 19:36:54.719326171 +0000
@@ -11,6 +11,7 @@
<pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/ImageModel.html">ImageModel</a></pre>
</p>
<hr>
+ <p>Represents an image model (like Imagen), capable of generating images based on various input types.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -28,12 +29,14 @@
<td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationResponse.html">ImagenGenerationResponse</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenInlineImage.html">ImagenInlineImage</a>></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/ImageModel.html#generateImage(kotlin.String,com.google.firebase.vertexai.type.ImagenGenerationConfig)">generateImage</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> prompt, <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a> config)</code></div>
+ <p>Generates an image, returning the result directly to the caller.</p>
</td>
</tr>
<tr>
<td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationResponse.html">ImagenGenerationResponse</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGCSImage.html">ImagenGCSImage</a>></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/ImageModel.html#generateImage(kotlin.String,kotlin.String,com.google.firebase.vertexai.type.ImagenGenerationConfig)">generateImage</a>(<br> @<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> prompt,<br> @<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> gcsUri,<br> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a> config<br>)</code></div>
+ <p>Generates an image, storing the result in Google Cloud Storage and returning a URL</p>
</td>
</tr>
</tbody>
@@ -44,10 +47,72 @@
<div class="api-item"><a name="generateImage(kotlin.String, com.google.firebase.vertexai.type.ImagenGenerationConfig)"></a><a name="generateImage-kotlin.String-com.google.firebase.vertexai.type.ImagenGenerationConfig-"></a><a name="generateimage"></a>
<h3 class="api-name" id="generateImage(kotlin.String,com.google.firebase.vertexai.type.ImagenGenerationConfig)">generateImage</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="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationResponse.html">ImagenGenerationResponse</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenInlineImage.html">ImagenInlineImage</a>> <a href="/docs/reference/android/com/google/firebase/vertexai/ImageModel.html#generateImage(kotlin.String,com.google.firebase.vertexai.type.ImagenGenerationConfig)">generateImage</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> prompt, <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a> config)</pre>
+ <p>Generates an image, returning the result directly to the caller.</p>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Parameters</th>
+ </tr>
+ </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> prompt</code></td>
+ <td>
+ <p>The main text prompt from which the image is generated.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a> config</code></td>
+ <td>
+ <p>contains secondary image generation parameters.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
<div class="api-item"><a name="generateImage(kotlin.String, kotlin.String, com.google.firebase.vertexai.type.ImagenGenerationConfig)"></a><a name="generateImage-kotlin.String-kotlin.String-com.google.firebase.vertexai.type.ImagenGenerationConfig-"></a><a name="generateimage"></a>
<h3 class="api-name" id="generateImage(kotlin.String,kotlin.String,com.google.firebase.vertexai.type.ImagenGenerationConfig)">generateImage</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="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationResponse.html">ImagenGenerationResponse</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGCSImage.html">ImagenGCSImage</a>> <a href="/docs/reference/android/com/google/firebase/vertexai/ImageModel.html#generateImage(kotlin.String,kotlin.String,com.google.firebase.vertexai.type.ImagenGenerationConfig)">generateImage</a>(<br> @<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> prompt,<br> @<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> gcsUri,<br> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a> config<br>)</pre>
+ <p>Generates an image, storing the result in Google Cloud Storage and returning a URL</p>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Parameters</th>
+ </tr>
+ </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> prompt</code></td>
+ <td>
+ <p>The main text prompt from which the image is generated.</p>
+ </td>
+ </tr>
+ <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> gcsUri</code></td>
+ <td>
+ <p>Specifies the GCS bucket in which to store the image.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a> config</code></td>
+ <td>
+ <p>contains secondary image generation parameters.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/package-summary.html 2025-01-07 19:39:03.931824591 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/package-summary.html 2025-01-07 19:36:54.718326168 +0000
@@ -38,7 +38,9 @@
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/ImageModel.html">ImageModel</a></code></td>
- <td></td>
+ <td>
+ <p>Represents an image model (like Imagen), capable of generating images based on various input types.</p>
+ </td>
</tr>
</tbody>
</table> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImageFormat.Companion.html 2025-01-07 19:39:03.926824573 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImageFormat.Companion.html 2025-01-07 19:36:54.713326148 +0000
@@ -28,12 +28,14 @@
<td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImageFormat.html">ImageFormat</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImageFormat.Companion.html#jpeg(kotlin.Int)">jpeg</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/Integer.html">Integer</a> compressionQuality)</code></div>
+ <p>An <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImageFormat.html">ImageFormat</a></code> representing a JPEG image.</p>
</td>
</tr>
<tr>
<td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImageFormat.html">ImageFormat</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImageFormat.Companion.html#png()">png</a>()</code></div>
+ <p>An <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImageFormat.html">ImageFormat</a></code> representing a PNG image</p>
</td>
</tr>
</tbody>
@@ -44,10 +46,33 @@
<div class="api-item"><a name="jpeg-kotlin.Int-"></a><a name="jpeg"></a>
<h3 class="api-name" id="jpeg(kotlin.Int)">jpeg</h3>
<pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImageFormat.html">ImageFormat</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImageFormat.Companion.html#jpeg(kotlin.Int)">jpeg</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/Integer.html">Integer</a> compressionQuality)</pre>
+ <p>An <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImageFormat.html">ImageFormat</a></code> representing a JPEG image.</p>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Parameters</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/Integer.html">Integer</a> compressionQuality</code></td>
+ <td>
+ <p>an int (1-100) representing how the quality of the image, a lower number meaning the image is permitted to be lower quality to reduce size.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
<div class="api-item"><a name="png--"></a><a name="png"></a>
<h3 class="api-name" id="png()">png</h3>
<pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImageFormat.html">ImageFormat</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImageFormat.Companion.html#png()">png</a>()</pre>
+ <p>An <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImageFormat.html">ImageFormat</a></code> representing a PNG image</p>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImageFormat.html 2025-01-07 19:39:03.926824573 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImageFormat.html 2025-01-07 19:36:54.713326148 +0000
@@ -11,6 +11,7 @@
<pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImageFormat.html">ImageFormat</a></pre>
</p>
<hr>
+ <p>Represents the format an image should be returned in.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -48,12 +49,14 @@
<td><code>final <a href="https://developer.android.com/reference/kotlin/java/lang/Integer.html">Integer</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImageFormat.html#compressionQuality()">compressionQuality</a></code></div>
+ <p>an int (1-100) representing how the quality of the image, a lower number meaning the image is permitted to be lower quality to reduce size.</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/ImageFormat.html#mimeType()">mimeType</a></code></div>
+ <p>A string (like "image/jpeg") specifying the encoding mimetype of the image.</p>
</td>
</tr>
</tbody>
@@ -64,10 +67,12 @@
<div class="api-item"><a name="getCompressionQuality()"></a><a name="setCompressionQuality()"></a><a name="getCompressionQuality--"></a><a name="setCompressionQuality--"></a>
<h3 class="api-name" id="compressionQuality()">compressionQuality</h3>
<pre class="api-signature no-pretty-print">public final <a href="https://developer.android.com/reference/kotlin/java/lang/Integer.html">Integer</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImageFormat.html#compressionQuality()">compressionQuality</a></pre>
+ <p>an int (1-100) representing how the quality of the image, a lower number meaning the image is permitted to be lower quality to reduce size. This parameter is not relevant for every mimetype</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/ImageFormat.html#mimeType()">mimeType</a></pre>
+ <p>A string (like "image/jpeg") specifying the encoding mimetype of the image.</p>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImageSafetySettings.html 2025-01-07 19:39:03.929824584 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImageSafetySettings.html 2025-01-07 19:36:54.716326160 +0000
@@ -11,6 +11,7 @@
<pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImageSafetySettings.html">ImageSafetySettings</a></pre>
</p>
<hr>
+ <p>A configuration for filtering unsafe content or images containing people.</p>
</body>
</html>
--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html 2025-01-07 19:39:03.925824569 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html 2025-01-07 19:36:54.713326148 +0000
@@ -29,6 +29,7 @@
</table>
</div>
<hr>
+ <p>Represents the aspect ratio that the generated image should conform to.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -44,23 +45,33 @@
<tbody class="list">
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html#LANDSCAPE_16x9">LANDSCAPE_16x9</a></code></td>
- <td></td>
+ <td>
+ <p>A landscape image in 16:9, the aspect ratio of modern monitors and phone screens.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html#LANDSCAPE_4x3">LANDSCAPE_4x3</a></code></td>
- <td></td>
+ <td>
+ <p>A landscape image in 4:3, the aspect ratio of older TVs.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html#PORTRAIT_3x4">PORTRAIT_3x4</a></code></td>
- <td></td>
+ <td>
+ <p>A portrait image in 3:4, the aspect ratio of older TVs.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html#PORTRAIT_9x16">PORTRAIT_9x16</a></code></td>
- <td></td>
+ <td>
+ <p>A portrait image in 9:16, the aspect ratio of modern monitors and phone screens.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html#SQUARE_1x1">SQUARE_1x1</a></code></td>
- <td></td>
+ <td>
+ <p>A square image, useful for icons, profile pictures, etc.</p>
+ </td>
</tr>
</tbody>
</table>
@@ -99,22 +110,27 @@
<div class="api-item">
<h3 class="api-name" id="LANDSCAPE_16x9">LANDSCAPE_16x9</h3>
<pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html#LANDSCAPE_16x9">ImagenAspectRatio.LANDSCAPE_16x9</a></pre>
+ <p>A landscape image in 16:9, the aspect ratio of modern monitors and phone screens.</p>
</div>
<div class="api-item">
<h3 class="api-name" id="LANDSCAPE_4x3">LANDSCAPE_4x3</h3>
<pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html#LANDSCAPE_4x3">ImagenAspectRatio.LANDSCAPE_4x3</a></pre>
+ <p>A landscape image in 4:3, the aspect ratio of older TVs.</p>
</div>
<div class="api-item">
<h3 class="api-name" id="PORTRAIT_3x4">PORTRAIT_3x4</h3>
<pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html#PORTRAIT_3x4">ImagenAspectRatio.PORTRAIT_3x4</a></pre>
+ <p>A portrait image in 3:4, the aspect ratio of older TVs.</p>
</div>
<div class="api-item">
<h3 class="api-name" id="PORTRAIT_9x16">PORTRAIT_9x16</h3>
<pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html#PORTRAIT_9x16">ImagenAspectRatio.PORTRAIT_9x16</a></pre>
+ <p>A portrait image in 9:16, the aspect ratio of modern monitors and phone screens.</p>
</div>
<div class="api-item">
<h3 class="api-name" id="SQUARE_1x1">SQUARE_1x1</h3>
<pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html#SQUARE_1x1">ImagenAspectRatio.SQUARE_1x1</a></pre>
+ <p>A square image, useful for icons, profile pictures, etc.</p>
</div>
</div>
<div class="list"> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGCSImage.html 2025-01-07 19:39:03.929824584 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGCSImage.html 2025-01-07 19:36:54.715326156 +0000
@@ -11,6 +11,7 @@
<pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGCSImage.html">ImagenGCSImage</a> implements <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImageRepresentible.html">ImagenImageRepresentible</a></pre>
</p>
<hr>
+ <p>Represents an Imagen Image that is contained in Google Cloud Storage.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -28,12 +29,14 @@
<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/ImagenGCSImage.html#gcsUri()">gcsUri</a></code></div>
+ <p>Contains the gs:// uri for the image.</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/ImagenGCSImage.html#mimeType()">mimeType</a></code></div>
+ <p>Contains the mime type of the image eg.</p>
</td>
</tr>
</tbody>
@@ -85,10 +88,12 @@
<div class="api-item"><a name="getGcsUri()"></a><a name="setGcsUri()"></a><a name="getGcsUri--"></a><a name="setGcsUri--"></a>
<h3 class="api-name" id="gcsUri()">gcsUri</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/ImagenGCSImage.html#gcsUri()">gcsUri</a></pre>
+ <p>Contains the gs:// uri for the image.</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/ImagenGCSImage.html#mimeType()">mimeType</a></pre>
+ <p>Contains the mime type of the image eg. "image/png"</p>
</div>
</div>
<div class="list">
@@ -96,6 +101,33 @@
<div class="api-item"><a name="ImagenGCSImage(kotlin.String, kotlin.String)"></a><a name="ImagenGCSImage-kotlin.String-kotlin.String-"></a><a name="imagengcsimage"></a>
<h3 class="api-name" id="ImagenGCSImage(kotlin.String,kotlin.String)">ImagenGCSImage</h3>
<pre class="api-signature no-pretty-print">public <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGCSImage.html#ImagenGCSImage(kotlin.String,kotlin.String)">ImagenGCSImage</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> gcsUri, @<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> mimeType)</pre>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Parameters</th>
+ </tr>
+ </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> gcsUri</code></td>
+ <td>
+ <p>Contains the gs:// uri for the image.</p>
+ </td>
+ </tr>
+ <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> mimeType</code></td>
+ <td>
+ <p>Contains the mime type of the image eg. "image/png"</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
</div>
<div class="list"> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html 2025-01-07 19:39:03.928824580 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html 2025-01-07 19:36:54.715326156 +0000
@@ -11,6 +11,7 @@
<pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a></pre>
</p>
<hr>
+ <p>Contains extra settings to configure image generation</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -28,18 +29,21 @@
<td><code>final <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#aspectRatio()">aspectRatio</a></code></div>
+ <p>The aspect ratio of the generated images.</p>
</td>
</tr>
<tr>
<td><code>final <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/ImagenGenerationConfig.html#negativePrompt()">negativePrompt</a></code></div>
+ <p>This string contains things that should be explicitly be excluded from generated images.</p>
</td>
</tr>
<tr>
<td><code>final int</code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#numberOfImages()">numberOfImages</a></code></div>
+ <p>How many images should be generated.</p>
</td>
</tr>
</tbody>
@@ -70,14 +74,17 @@
<div class="api-item"><a name="getAspectRatio()"></a><a name="setAspectRatio()"></a><a name="getAspectRatio--"></a><a name="setAspectRatio--"></a>
<h3 class="api-name" id="aspectRatio()">aspectRatio</h3>
<pre class="api-signature no-pretty-print">public final <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#aspectRatio()">aspectRatio</a></pre>
+ <p>The aspect ratio of the generated images.</p>
</div>
<div class="api-item"><a name="getNegativePrompt()"></a><a name="setNegativePrompt()"></a><a name="getNegativePrompt--"></a><a name="setNegativePrompt--"></a>
<h3 class="api-name" id="negativePrompt()">negativePrompt</h3>
<pre class="api-signature no-pretty-print">public final <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#negativePrompt()">negativePrompt</a></pre>
+ <p>This string contains things that should be explicitly be excluded from generated images.</p>
</div>
<div class="api-item"><a name="getNumberOfImages()"></a><a name="setNumberOfImages()"></a><a name="getNumberOfImages--"></a><a name="setNumberOfImages--"></a>
<h3 class="api-name" id="numberOfImages()">numberOfImages</h3>
<pre class="api-signature no-pretty-print">public final int <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#numberOfImages()">numberOfImages</a></pre>
+ <p>How many images should be generated.</p>
</div>
</div>
<div class="list">
@@ -85,6 +92,39 @@
<div class="api-item"><a name="ImagenGenerationConfig(kotlin.String, kotlin.Int, com.google.firebase.vertexai.type.ImagenAspectRatio)"></a><a name="ImagenGenerationConfig-kotlin.String-kotlin.Int-com.google.firebase.vertexai.type.ImagenAspectRatio-"></a><a name="imagengenerationconfig"></a>
<h3 class="api-name" id="ImagenGenerationConfig(kotlin.String,kotlin.Int,com.google.firebase.vertexai.type.ImagenAspectRatio)">ImagenGenerationConfig</h3>
<pre class="api-signature no-pretty-print">public <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#ImagenGenerationConfig(kotlin.String,kotlin.Int,com.google.firebase.vertexai.type.ImagenAspectRatio)">ImagenGenerationConfig</a>(<br> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> negativePrompt,<br> int numberOfImages,<br> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a> aspectRatio<br>)</pre>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Parameters</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> negativePrompt</code></td>
+ <td>
+ <p>This string contains things that should be explicitly be excluded from generated images.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>int numberOfImages</code></td>
+ <td>
+ <p>How many images should be generated.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a> aspectRatio</code></td>
+ <td>
+ <p>The aspect ratio of the generated images.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGenerationResponse.html 2025-01-07 19:39:03.926824573 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGenerationResponse.html 2025-01-07 19:36:54.713326148 +0000
@@ -11,6 +11,7 @@
<pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationResponse.html">ImagenGenerationResponse</a><T extends <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImageRepresentible.html">ImagenImageRepresentible</a>></pre>
</p>
<hr>
+ <p>Represents a response from Imagen call to ImageModel#generateImages</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -28,12 +29,14 @@
<td><code>final <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/ImagenGenerationResponse.html#filteredReason()">filteredReason</a></code></div>
+ <p>if fewer images were generated than were requested, this field will contain the reason they were filtered out.</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/util/List.html">List</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> T></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationResponse.html#images()">images</a></code></div>
+ <p>contains the generated images</p>
</td>
</tr>
</tbody>
@@ -64,10 +67,12 @@
<div class="api-item"><a name="getFilteredReason()"></a><a name="setFilteredReason()"></a><a name="getFilteredReason--"></a><a name="setFilteredReason--"></a>
<h3 class="api-name" id="filteredReason()">filteredReason</h3>
<pre class="api-signature no-pretty-print">public final <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationResponse.html#filteredReason()">filteredReason</a></pre>
+ <p>if fewer images were generated than were requested, this field will contain the reason they were filtered out.</p>
</div>
<div class="api-item"><a name="getImages()"></a><a name="setImages()"></a><a name="getImages--"></a><a name="setImages--"></a>
<h3 class="api-name" id="images()">images</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/util/List.html">List</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> T> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationResponse.html#images()">images</a></pre>
+ <p>contains the generated images</p>
</div>
</div>
<div class="list">
@@ -75,6 +80,33 @@
<div class="api-item"><a name="ImagenGenerationResponse(kotlin.collections.List, kotlin.String)"></a><a name="ImagenGenerationResponse-kotlin.collections.List-kotlin.String-"></a><a name="imagengenerationresponse"></a>
<h3 class="api-name" id="ImagenGenerationResponse(kotlin.collections.List,kotlin.String)">ImagenGenerationResponse</h3>
<pre class="api-signature no-pretty-print">public <T extends <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImageRepresentible.html">ImagenImageRepresentible</a>> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationResponse.html#ImagenGenerationResponse(kotlin.collections.List,kotlin.String)">ImagenGenerationResponse</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/List.html">List</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> T> images,<br> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> filteredReason<br>)</pre>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Parameters</th>
+ </tr>
+ </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/util/List.html">List</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> T> images</code></td>
+ <td>
+ <p>contains the generated images</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> filteredReason</code></td>
+ <td>
+ <p>if fewer images were generated than were requested, this field will contain the reason they were filtered out.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenImage.html 2025-01-07 19:39:03.930824588 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenImage.html 2025-01-07 19:36:54.717326163 +0000
@@ -11,6 +11,7 @@
<pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImage.html">ImagenImage</a> implements <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImageRepresentible.html">ImagenImageRepresentible</a></pre>
</p>
<hr>
+ <p>Represents an abstract Imagen Image that is either contained inline or in Google Cloud Storage</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -28,18 +29,21 @@
<td><code>final byte[]</code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImage.html#data()">data</a></code></div>
+ <p>Contains the raw bytes of the image, mutually exclusive with <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImage.html#gcsUri()">gcsUri</a></code></p>
</td>
</tr>
<tr>
<td><code>final <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/ImagenImage.html#gcsUri()">gcsUri</a></code></div>
+ <p>Contains the gs:// uri for the image , mutually exclusive with <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImage.html#data()">data</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/ImagenImage.html#mimeType()">mimeType</a></code></div>
+ <p>Contains the mime type of the image eg.</p>
</td>
</tr>
</tbody>
@@ -91,14 +95,17 @@
<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 byte[] <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImage.html#data()">data</a></pre>
+ <p>Contains the raw bytes of the image, mutually exclusive with <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImage.html#gcsUri()">gcsUri</a></code></p>
</div>
<div class="api-item"><a name="getGcsUri()"></a><a name="setGcsUri()"></a><a name="getGcsUri--"></a><a name="setGcsUri--"></a>
<h3 class="api-name" id="gcsUri()">gcsUri</h3>
<pre class="api-signature no-pretty-print">public final <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImage.html#gcsUri()">gcsUri</a></pre>
+ <p>Contains the gs:// uri for the image , mutually exclusive with <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImage.html#data()">data</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/ImagenImage.html#mimeType()">mimeType</a></pre>
+ <p>Contains the mime type of the image eg. "image/png"</p>
</div>
</div>
<div class="list">
@@ -106,6 +113,39 @@
<div class="api-item"><a name="ImagenImage(kotlin.ByteArray, kotlin.String, kotlin.String)"></a><a name="ImagenImage-kotlin.ByteArray-kotlin.String-kotlin.String-"></a><a name="imagenimage"></a>
<h3 class="api-name" id="ImagenImage(kotlin.ByteArray,kotlin.String,kotlin.String)">ImagenImage</h3>
<pre class="api-signature no-pretty-print">public <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImage.html#ImagenImage(kotlin.ByteArray,kotlin.String,kotlin.String)">ImagenImage</a>(byte[] data, <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> gcsUri, @<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> mimeType)</pre>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Parameters</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>byte[] data</code></td>
+ <td>
+ <p>Contains the raw bytes of the image, mutually exclusive with <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImage.html#<init>(kotlin.ByteArray,kotlin.String,kotlin.String)">gcsUri</a></code></p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> gcsUri</code></td>
+ <td>
+ <p>Contains the gs:// uri for the image , mutually exclusive with <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImage.html#<init>(kotlin.ByteArray,kotlin.String,kotlin.String)">data</a></code></p>
+ </td>
+ </tr>
+ <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> mimeType</code></td>
+ <td>
+ <p>Contains the mime type of the image eg. "image/png"</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
</div>
<div class="list"> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenImageRepresentible.html 2025-01-07 19:39:03.925824569 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenImageRepresentible.html 2025-01-07 19:36:54.713326148 +0000
@@ -23,15 +23,21 @@
<tbody class="list">
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGCSImage.html">ImagenGCSImage</a></code></td>
- <td></td>
+ <td>
+ <p>Represents an Imagen Image that is contained in Google Cloud Storage.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImage.html">ImagenImage</a></code></td>
- <td></td>
+ <td>
+ <p>Represents an abstract Imagen Image that is either contained inline or in Google Cloud Storage</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenInlineImage.html">ImagenInlineImage</a></code></td>
- <td></td>
+ <td>
+ <p>Represents an Imagen Image that is contained inline</p>
+ </td>
</tr>
</tbody>
</table>
@@ -39,6 +45,7 @@
</div>
</devsite-expandable> </div>
<hr>
+ <p>Interface representing images which can be passed into Imagen (for upscaling, editing, etc.)</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive"> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenInlineImage.html 2025-01-07 19:39:03.930824588 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenInlineImage.html 2025-01-07 19:36:54.717326163 +0000
@@ -11,6 +11,7 @@
<pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenInlineImage.html">ImagenInlineImage</a> implements <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImageRepresentible.html">ImagenImageRepresentible</a></pre>
</p>
<hr>
+ <p>Represents an Imagen Image that is contained inline</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -28,12 +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>
</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 eg.</p>
</td>
</tr>
</tbody>
@@ -75,6 +78,7 @@
<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/android/graphics/Bitmap.html">Bitmap</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenInlineImage.html#asBitmap()">asBitmap</a>()</code></div>
+ <p>Returns the image as an android OS native <code><a href="https://developer.android.com/reference/kotlin/android/graphics/Bitmap.html">Bitmap</a></code> so that it can be saved or sent to the UI.</p>
</td>
</tr>
<tr>
@@ -91,10 +95,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>
</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 eg. "image/png"</p>
</div>
</div>
<div class="list">
@@ -102,6 +108,33 @@
<div class="api-item"><a name="ImagenInlineImage(kotlin.ByteArray, kotlin.String)"></a><a name="ImagenInlineImage-kotlin.ByteArray-kotlin.String-"></a><a name="imageninlineimage"></a>
<h3 class="api-name" id="ImagenInlineImage(kotlin.ByteArray,kotlin.String)">ImagenInlineImage</h3>
<pre class="api-signature no-pretty-print">public <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenInlineImage.html#ImagenInlineImage(kotlin.ByteArray,kotlin.String)">ImagenInlineImage</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> byte[] data, @<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> mimeType)</pre>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Parameters</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> byte[] data</code></td>
+ <td>
+ <p>Contains the raw bytes of the image</p>
+ </td>
+ </tr>
+ <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> mimeType</code></td>
+ <td>
+ <p>Contains the mime type of the image eg. "image/png"</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
</div>
<div class="list">
@@ -109,6 +142,7 @@
<div class="api-item"><a name="asBitmap--"></a><a name="asbitmap"></a>
<h3 class="api-name" id="asBitmap()">asBitmap</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/android/graphics/Bitmap.html">Bitmap</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenInlineImage.html#asBitmap()">asBitmap</a>()</pre>
+ <p>Returns the image as an android OS native <code><a href="https://developer.android.com/reference/kotlin/android/graphics/Bitmap.html">Bitmap</a></code> so that it can be saved or sent to the UI.</p>
</div>
<div class="api-item"><a name="asImagenImage--"></a><a name="asimagenimage"></a>
<h3 class="api-name" id="asImagenImage()">asImagenImage</h3> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenModelConfig.html 2025-01-07 19:39:03.929824584 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenModelConfig.html 2025-01-07 19:36:54.715326156 +0000
@@ -11,6 +11,7 @@
<pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenModelConfig.html">ImagenModelConfig</a></pre>
</p>
<hr>
+ <p>Contains extra configuration options for the Imagen model.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -28,12 +29,14 @@
<td><code>final <a href="https://developer.android.com/reference/kotlin/java/lang/Boolean.html">Boolean</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenModelConfig.html#addWatermark()">addWatermark</a></code></div>
+ <p>If true, the image is invisibly watermarked as AI generated.</p>
</td>
</tr>
<tr>
<td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImageFormat.html">ImageFormat</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenModelConfig.html#imageFormat()">imageFormat</a></code></div>
+ <p>Specifies the encoding format for the image.</p>
</td>
</tr>
</tbody>
@@ -44,10 +47,12 @@
<div class="api-item"><a name="getAddWatermark()"></a><a name="setAddWatermark()"></a><a name="getAddWatermark--"></a><a name="setAddWatermark--"></a>
<h3 class="api-name" id="addWatermark()">addWatermark</h3>
<pre class="api-signature no-pretty-print">public final <a href="https://developer.android.com/reference/kotlin/java/lang/Boolean.html">Boolean</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenModelConfig.html#addWatermark()">addWatermark</a></pre>
+ <p>If true, the image is invisibly watermarked as AI generated.</p>
</div>
<div class="api-item"><a name="getImageFormat()"></a><a name="setImageFormat()"></a><a name="getImageFormat--"></a><a name="setImageFormat--"></a>
<h3 class="api-name" id="imageFormat()">imageFormat</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="/docs/reference/android/com/google/firebase/vertexai/type/ImageFormat.html">ImageFormat</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenModelConfig.html#imageFormat()">imageFormat</a></pre>
+ <p>Specifies the encoding format for the image.</p>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenPersonFilter.html 2025-01-07 19:39:03.924824565 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenPersonFilter.html 2025-01-07 19:36:54.711326141 +0000
@@ -29,6 +29,7 @@
</table>
</div>
<hr>
+ <p>A filter used to prevent images from containing depictions of people or children.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -44,15 +45,21 @@
<tbody class="list">
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenPersonFilter.html#ALLOW_ADULT">ALLOW_ADULT</a></code></td>
- <td></td>
+ <td>
+ <p>Filters out any images containing depictions of children.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenPersonFilter.html#ALLOW_ALL">ALLOW_ALL</a></code></td>
- <td></td>
+ <td>
+ <p>Doesn't apply any filtering.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenPersonFilter.html#BLOCK_ALL">BLOCK_ALL</a></code></td>
- <td></td>
+ <td>
+ <p>Filters out any images with depictions of people.</p>
+ </td>
</tr>
</tbody>
</table>
@@ -91,14 +98,17 @@
<div class="api-item">
<h3 class="api-name" id="ALLOW_ADULT">ALLOW_ADULT</h3>
<pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenPersonFilter.html">ImagenPersonFilter</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenPersonFilter.html#ALLOW_ADULT">ImagenPersonFilter.ALLOW_ADULT</a></pre>
+ <p>Filters out any images containing depictions of children.</p>
</div>
<div class="api-item">
<h3 class="api-name" id="ALLOW_ALL">ALLOW_ALL</h3>
<pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenPersonFilter.html">ImagenPersonFilter</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenPersonFilter.html#ALLOW_ALL">ImagenPersonFilter.ALLOW_ALL</a></pre>
+ <p>Doesn't apply any filtering.</p>
</div>
<div class="api-item">
<h3 class="api-name" id="BLOCK_ALL">BLOCK_ALL</h3>
<pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenPersonFilter.html">ImagenPersonFilter</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenPersonFilter.html#BLOCK_ALL">ImagenPersonFilter.BLOCK_ALL</a></pre>
+ <p>Filters out any images with depictions of people.</p>
</div>
</div>
<div class="list"> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenSafetyFilter.html 2025-01-07 19:39:03.927824577 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenSafetyFilter.html 2025-01-07 19:36:54.714326152 +0000
@@ -29,6 +29,7 @@
</table>
</div>
<hr>
+ <p>Used for safety filtering.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -44,15 +45,21 @@
<tbody class="list">
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetyFilter.html#BLOCK_LOW_AND_ABOVE">BLOCK_LOW_AND_ABOVE</a></code></td>
- <td></td>
+ <td>
+ <p>Strongest filtering level, most strict blocking.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetyFilter.html#BLOCK_MEDIUM_AND_ABOVE">BLOCK_MEDIUM_AND_ABOVE</a></code></td>
- <td></td>
+ <td>
+ <p>Block some problematic prompts and responses.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetyFilter.html#BLOCK_ONLY_HIGH">BLOCK_ONLY_HIGH</a></code></td>
- <td></td>
+ <td>
+ <p>Reduces the number of requests blocked due to safety filters.</p>
+ </td>
</tr>
</tbody>
</table>
@@ -91,14 +98,17 @@
<div class="api-item">
<h3 class="api-name" id="BLOCK_LOW_AND_ABOVE">BLOCK_LOW_AND_ABOVE</h3>
<pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetyFilter.html">ImagenSafetyFilter</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetyFilter.html#BLOCK_LOW_AND_ABOVE">ImagenSafetyFilter.BLOCK_LOW_AND_ABOVE</a></pre>
+ <p>Strongest filtering level, most strict blocking.</p>
</div>
<div class="api-item">
<h3 class="api-name" id="BLOCK_MEDIUM_AND_ABOVE">BLOCK_MEDIUM_AND_ABOVE</h3>
<pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetyFilter.html">ImagenSafetyFilter</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetyFilter.html#BLOCK_MEDIUM_AND_ABOVE">ImagenSafetyFilter.BLOCK_MEDIUM_AND_ABOVE</a></pre>
+ <p>Block some problematic prompts and responses.</p>
</div>
<div class="api-item">
<h3 class="api-name" id="BLOCK_ONLY_HIGH">BLOCK_ONLY_HIGH</h3>
<pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetyFilter.html">ImagenSafetyFilter</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetyFilter.html#BLOCK_ONLY_HIGH">ImagenSafetyFilter.BLOCK_ONLY_HIGH</a></pre>
+ <p>Reduces the number of requests blocked due to safety filters. May increase objectionable content generated by Imagen.</p>
</div>
</div>
<div class="list"> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/package-summary.html 2025-01-07 19:39:03.927824577 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/package-summary.html 2025-01-07 19:36:54.714326152 +0000
@@ -16,7 +16,9 @@
<tbody class="list">
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImageRepresentible.html">ImagenImageRepresentible</a></code></td>
- <td></td>
+ <td>
+ <p>Interface representing images which can be passed into Imagen (for upscaling, editing, etc.)</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/Part.html">Part</a></code></td>
@@ -171,7 +173,9 @@
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImageFormat.html">ImageFormat</a></code></td>
- <td></td>
+ <td>
+ <p>Represents the format an image should be returned in.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagePart.html">ImagePart</a></code></td>
@@ -181,31 +185,45 @@
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImageSafetySettings.html">ImageSafetySettings</a></code></td>
- <td></td>
+ <td>
+ <p>A configuration for filtering unsafe content or images containing people.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGCSImage.html">ImagenGCSImage</a></code></td>
- <td></td>
+ <td>
+ <p>Represents an Imagen Image that is contained in Google Cloud Storage.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a></code></td>
- <td></td>
+ <td>
+ <p>Contains extra settings to configure image generation</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationResponse.html">ImagenGenerationResponse</a></code></td>
- <td></td>
+ <td>
+ <p>Represents a response from Imagen call to ImageModel#generateImages</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImage.html">ImagenImage</a></code></td>
- <td></td>
+ <td>
+ <p>Represents an abstract Imagen Image that is either contained inline or in Google Cloud Storage</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenInlineImage.html">ImagenInlineImage</a></code></td>
- <td></td>
+ <td>
+ <p>Represents an Imagen Image that is contained inline</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenModelConfig.html">ImagenModelConfig</a></code></td>
- <td></td>
+ <td>
+ <p>Contains extra configuration options for the Imagen model.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/InlineDataPart.html">InlineDataPart</a></code></td>
@@ -292,15 +310,21 @@
<tbody class="list">
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a></code></td>
- <td></td>
+ <td>
+ <p>Represents the aspect ratio that the generated image should conform to.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenPersonFilter.html">ImagenPersonFilter</a></code></td>
- <td></td>
+ <td>
+ <p>A filter used to prevent images from containing depictions of people or children.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetyFilter.html">ImagenSafetyFilter</a></code></td>
- <td></td>
+ <td>
+ <p>Used for safety filtering.</p>
+ </td>
</tr>
</tbody>
</table> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/FirebaseVertexAI.html 2025-01-07 19:39:03.938824618 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/FirebaseVertexAI.html 2025-01-07 19:36:54.726326198 +0000
@@ -86,6 +86,7 @@
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImageModel.html">ImageModel</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/FirebaseVertexAI.html#imageModel(kotlin.String,com.google.firebase.vertexai.type.ImagenModelConfig,com.google.firebase.vertexai.type.ImageSafetySettings,com.google.firebase.vertexai.type.RequestOptions)">imageModel</a>(<br> modelName: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>,<br> generationConfig: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenModelConfig.html">ImagenModelConfig</a>?,<br> safetySettings: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImageSafetySettings.html">ImageSafetySettings</a>?,<br> requestOptions: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/RequestOptions.html">RequestOptions</a><br>)</code></div>
+ <p>Instantiates a new <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImageModel.html">ImageModel</a></code> given the provided parameters.</p>
</td>
</tr>
</tbody>
@@ -220,6 +221,67 @@
<div class="api-item"><a name="imageModel(kotlin.String, com.google.firebase.vertexai.type.ImagenModelConfig, com.google.firebase.vertexai.type.ImageSafetySettings, com.google.firebase.vertexai.type.RequestOptions)"></a><a name="imageModel-kotlin.String-com.google.firebase.vertexai.type.ImagenModelConfig-com.google.firebase.vertexai.type.ImageSafetySettings-com.google.firebase.vertexai.type.RequestOptions-"></a><a name="imagemodel"></a>
<h3 class="api-name" id="imageModel(kotlin.String,com.google.firebase.vertexai.type.ImagenModelConfig,com.google.firebase.vertexai.type.ImageSafetySettings,com.google.firebase.vertexai.type.RequestOptions)">imageModel</h3>
<pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/FirebaseVertexAI.html#imageModel(kotlin.String,com.google.firebase.vertexai.type.ImagenModelConfig,com.google.firebase.vertexai.type.ImageSafetySettings,com.google.firebase.vertexai.type.RequestOptions)">imageModel</a>(<br> modelName: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>,<br> generationConfig: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenModelConfig.html">ImagenModelConfig</a>? = null,<br> safetySettings: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImageSafetySettings.html">ImageSafetySettings</a>? = null,<br> requestOptions: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/RequestOptions.html">RequestOptions</a> = RequestOptions()<br>): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImageModel.html">ImageModel</a></pre>
+ <p>Instantiates a new <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImageModel.html">ImageModel</a></code> given the provided parameters.</p>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Parameters</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>modelName: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
+ <td>
+ <p>The name of the model to use, for example <code>"imagen-3.0-generate-001"</code>.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>generationConfig: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenModelConfig.html">ImagenModelConfig</a>? = null</code></td>
+ <td>
+ <p>The configuration parameters to use for image generation.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>safetySettings: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImageSafetySettings.html">ImageSafetySettings</a>? = null</code></td>
+ <td>
+ <p>The safety bounds the model will abide to during image generation.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>requestOptions: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/RequestOptions.html">RequestOptions</a> = RequestOptions()</code></td>
+ <td>
+ <p>Configuration options for sending requests to the backend.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Returns</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImageModel.html">ImageModel</a></code></td>
+ <td>
+ <p>The initialized <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImageModel.html">ImageModel</a></code> instance.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/ImageModel.html 2025-01-07 19:39:03.938824618 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/ImageModel.html 2025-01-07 19:36:54.726326198 +0000
@@ -11,6 +11,7 @@
<pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImageModel.html">ImageModel</a></pre>
</p>
<hr>
+ <p>Represents an image model (like Imagen), capable of generating images based on various input types.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -28,12 +29,14 @@
<td><code>suspend <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationResponse.html">ImagenGenerationResponse</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html">ImagenInlineImage</a>></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImageModel.html#generateImage(kotlin.String,com.google.firebase.vertexai.type.ImagenGenerationConfig)">generateImage</a>(prompt: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, config: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a>?)</code></div>
+ <p>Generates an image, returning the result directly to the caller.</p>
</td>
</tr>
<tr>
<td><code>suspend <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationResponse.html">ImagenGenerationResponse</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGCSImage.html">ImagenGCSImage</a>></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImageModel.html#generateImage(kotlin.String,kotlin.String,com.google.firebase.vertexai.type.ImagenGenerationConfig)">generateImage</a>(<br> prompt: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>,<br> gcsUri: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>,<br> config: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a>?<br>)</code></div>
+ <p>Generates an image, storing the result in Google Cloud Storage and returning a URL</p>
</td>
</tr>
</tbody>
@@ -44,10 +47,72 @@
<div class="api-item"><a name="generateImage(kotlin.String, com.google.firebase.vertexai.type.ImagenGenerationConfig)"></a><a name="generateImage-kotlin.String-com.google.firebase.vertexai.type.ImagenGenerationConfig-"></a><a name="generateimage"></a>
<h3 class="api-name" id="generateImage(kotlin.String,com.google.firebase.vertexai.type.ImagenGenerationConfig)">generateImage</h3>
<pre class="api-signature no-pretty-print">suspend fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImageModel.html#generateImage(kotlin.String,com.google.firebase.vertexai.type.ImagenGenerationConfig)">generateImage</a>(prompt: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, config: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a>?): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationResponse.html">ImagenGenerationResponse</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html">ImagenInlineImage</a>></pre>
+ <p>Generates an image, returning the result directly to the caller.</p>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Parameters</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>prompt: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
+ <td>
+ <p>The main text prompt from which the image is generated.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>config: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a>?</code></td>
+ <td>
+ <p>contains secondary image generation parameters.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
<div class="api-item"><a name="generateImage(kotlin.String, kotlin.String, com.google.firebase.vertexai.type.ImagenGenerationConfig)"></a><a name="generateImage-kotlin.String-kotlin.String-com.google.firebase.vertexai.type.ImagenGenerationConfig-"></a><a name="generateimage"></a>
<h3 class="api-name" id="generateImage(kotlin.String,kotlin.String,com.google.firebase.vertexai.type.ImagenGenerationConfig)">generateImage</h3>
<pre class="api-signature no-pretty-print">suspend fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImageModel.html#generateImage(kotlin.String,kotlin.String,com.google.firebase.vertexai.type.ImagenGenerationConfig)">generateImage</a>(<br> prompt: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>,<br> gcsUri: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>,<br> config: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a>?<br>): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationResponse.html">ImagenGenerationResponse</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGCSImage.html">ImagenGCSImage</a>></pre>
+ <p>Generates an image, storing the result in Google Cloud Storage and returning a URL</p>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Parameters</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>prompt: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
+ <td>
+ <p>The main text prompt from which the image is generated.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>gcsUri: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
+ <td>
+ <p>Specifies the GCS bucket in which to store the image.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>config: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a>?</code></td>
+ <td>
+ <p>contains secondary image generation parameters.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/package-summary.html 2025-01-07 19:39:03.938824618 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/package-summary.html 2025-01-07 19:36:54.725326194 +0000
@@ -34,7 +34,9 @@
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImageModel.html">ImageModel</a></code></td>
- <td></td>
+ <td>
+ <p>Represents an image model (like Imagen), capable of generating images based on various input types.</p>
+ </td>
</tr>
</tbody>
</table> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImageFormat.html 2025-01-07 19:39:03.934824603 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImageFormat.html 2025-01-07 19:36:54.721326179 +0000
@@ -11,6 +11,7 @@
<pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImageFormat.html">ImageFormat</a></pre>
</p>
<hr>
+ <p>Represents the format an image should be returned in.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -28,12 +29,14 @@
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImageFormat.html">ImageFormat</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImageFormat.Companion.html#jpeg(kotlin.Int)">jpeg</a>(compressionQuality: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>?)</code></div>
+ <p>An <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImageFormat.html">ImageFormat</a></code> representing a JPEG image.</p>
</td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImageFormat.html">ImageFormat</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImageFormat.Companion.html#png()">png</a>()</code></div>
+ <p>An <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImageFormat.html">ImageFormat</a></code> representing a PNG image</p>
</td>
</tr>
</tbody>
@@ -55,12 +58,14 @@
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>?</code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImageFormat.html#compressionQuality()">compressionQuality</a></code></div>
+ <p>an int (1-100) representing how the quality of the image, a lower number meaning the image is permitted to be lower quality to reduce size.</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/ImageFormat.html#mimeType()">mimeType</a></code></div>
+ <p>A string (like "image/jpeg") specifying the encoding mimetype of the image.</p>
</td>
</tr>
</tbody>
@@ -71,10 +76,33 @@
<div class="api-item"><a name="jpeg-kotlin.Int-"></a><a name="jpeg"></a>
<h3 class="api-name" id="jpeg(kotlin.Int)">jpeg</h3>
<pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImageFormat.Companion.html#jpeg(kotlin.Int)">jpeg</a>(compressionQuality: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>?): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImageFormat.html">ImageFormat</a></pre>
+ <p>An <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImageFormat.html">ImageFormat</a></code> representing a JPEG image.</p>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Parameters</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>compressionQuality: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>?</code></td>
+ <td>
+ <p>an int (1-100) representing how the quality of the image, a lower number meaning the image is permitted to be lower quality to reduce size.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
<div class="api-item"><a name="png--"></a><a name="png"></a>
<h3 class="api-name" id="png()">png</h3>
<pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImageFormat.Companion.html#png()">png</a>(): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImageFormat.html">ImageFormat</a></pre>
+ <p>An <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImageFormat.html">ImageFormat</a></code> representing a PNG image</p>
</div>
</div>
<div class="list">
@@ -82,10 +110,12 @@
<div class="api-item"><a name="getCompressionQuality()"></a><a name="setCompressionQuality()"></a><a name="getCompressionQuality--"></a><a name="setCompressionQuality--"></a>
<h3 class="api-name" id="compressionQuality()">compressionQuality</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImageFormat.html#compressionQuality()">compressionQuality</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>?</pre>
+ <p>an int (1-100) representing how the quality of the image, a lower number meaning the image is permitted to be lower quality to reduce size. This parameter is not relevant for every mimetype</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/ImageFormat.html#mimeType()">mimeType</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></pre>
+ <p>A string (like "image/jpeg") specifying the encoding mimetype of the image.</p>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImageSafetySettings.html 2025-01-07 19:39:03.936824610 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImageSafetySettings.html 2025-01-07 19:36:54.724326190 +0000
@@ -11,6 +11,7 @@
<pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImageSafetySettings.html">ImageSafetySettings</a></pre>
</p>
<hr>
+ <p>A configuration for filtering unsafe content or images containing people.</p>
</body>
</html>
--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html 2025-01-07 19:39:03.933824599 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html 2025-01-07 19:36:54.721326179 +0000
@@ -29,6 +29,7 @@
</table>
</div>
<hr>
+ <p>Represents the aspect ratio that the generated image should conform to.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -44,23 +45,33 @@
<tbody class="list">
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html#LANDSCAPE_16x9">LANDSCAPE_16x9</a></code></td>
- <td></td>
+ <td>
+ <p>A landscape image in 16:9, the aspect ratio of modern monitors and phone screens.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html#LANDSCAPE_4x3">LANDSCAPE_4x3</a></code></td>
- <td></td>
+ <td>
+ <p>A landscape image in 4:3, the aspect ratio of older TVs.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html#PORTRAIT_3x4">PORTRAIT_3x4</a></code></td>
- <td></td>
+ <td>
+ <p>A portrait image in 3:4, the aspect ratio of older TVs.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html#PORTRAIT_9x16">PORTRAIT_9x16</a></code></td>
- <td></td>
+ <td>
+ <p>A portrait image in 9:16, the aspect ratio of modern monitors and phone screens.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html#SQUARE_1x1">SQUARE_1x1</a></code></td>
- <td></td>
+ <td>
+ <p>A square image, useful for icons, profile pictures, etc.</p>
+ </td>
</tr>
</tbody>
</table>
@@ -99,22 +110,27 @@
<div class="api-item">
<h3 class="api-name" id="LANDSCAPE_16x9">LANDSCAPE_16x9</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html#LANDSCAPE_16x9">ImagenAspectRatio.LANDSCAPE_16x9</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a></pre>
+ <p>A landscape image in 16:9, the aspect ratio of modern monitors and phone screens.</p>
</div>
<div class="api-item">
<h3 class="api-name" id="LANDSCAPE_4x3">LANDSCAPE_4x3</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html#LANDSCAPE_4x3">ImagenAspectRatio.LANDSCAPE_4x3</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a></pre>
+ <p>A landscape image in 4:3, the aspect ratio of older TVs.</p>
</div>
<div class="api-item">
<h3 class="api-name" id="PORTRAIT_3x4">PORTRAIT_3x4</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html#PORTRAIT_3x4">ImagenAspectRatio.PORTRAIT_3x4</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a></pre>
+ <p>A portrait image in 3:4, the aspect ratio of older TVs.</p>
</div>
<div class="api-item">
<h3 class="api-name" id="PORTRAIT_9x16">PORTRAIT_9x16</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html#PORTRAIT_9x16">ImagenAspectRatio.PORTRAIT_9x16</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a></pre>
+ <p>A portrait image in 9:16, the aspect ratio of modern monitors and phone screens.</p>
</div>
<div class="api-item">
<h3 class="api-name" id="SQUARE_1x1">SQUARE_1x1</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html#SQUARE_1x1">ImagenAspectRatio.SQUARE_1x1</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a></pre>
+ <p>A square image, useful for icons, profile pictures, etc.</p>
</div>
</div>
<div class="list"> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenGCSImage.html 2025-01-07 19:39:03.936824610 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenGCSImage.html 2025-01-07 19:36:54.723326186 +0000
@@ -11,6 +11,7 @@
<pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGCSImage.html">ImagenGCSImage</a> : <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImageRepresentible.html">ImagenImageRepresentible</a></pre>
</p>
<hr>
+ <p>Represents an Imagen Image that is contained in Google Cloud Storage.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -69,12 +70,14 @@
<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/ImagenGCSImage.html#gcsUri()">gcsUri</a></code></div>
+ <p>Contains the gs:// uri for the image.</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/ImagenGCSImage.html#mimeType()">mimeType</a></code></div>
+ <p>Contains the mime type of the image eg.</p>
</td>
</tr>
</tbody>
@@ -85,6 +88,33 @@
<div class="api-item"><a name="ImagenGCSImage(kotlin.String, kotlin.String)"></a><a name="ImagenGCSImage-kotlin.String-kotlin.String-"></a><a name="imagengcsimage"></a>
<h3 class="api-name" id="ImagenGCSImage(kotlin.String,kotlin.String)">ImagenGCSImage</h3>
<pre class="api-signature no-pretty-print"><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGCSImage.html#ImagenGCSImage(kotlin.String,kotlin.String)">ImagenGCSImage</a>(gcsUri: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, mimeType: <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>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Parameters</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>gcsUri: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
+ <td>
+ <p>Contains the gs:// uri for the image.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>mimeType: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
+ <td>
+ <p>Contains the mime type of the image eg. "image/png"</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
</div>
<div class="list">
@@ -99,10 +129,12 @@
<div class="api-item"><a name="getGcsUri()"></a><a name="setGcsUri()"></a><a name="getGcsUri--"></a><a name="setGcsUri--"></a>
<h3 class="api-name" id="gcsUri()">gcsUri</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGCSImage.html#gcsUri()">gcsUri</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></pre>
+ <p>Contains the gs:// uri for the image.</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/ImagenGCSImage.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 eg. "image/png"</p>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html 2025-01-07 19:39:03.935824607 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html 2025-01-07 19:36:54.723326186 +0000
@@ -11,6 +11,7 @@
<pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a></pre>
</p>
<hr>
+ <p>Contains extra settings to configure image generation</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -48,18 +49,21 @@
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a>?</code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#aspectRatio()">aspectRatio</a></code></div>
+ <p>The aspect ratio of the generated images.</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/ImagenGenerationConfig.html#negativePrompt()">negativePrompt</a></code></div>
+ <p>This string contains things that should be explicitly be excluded from generated images.</p>
</td>
</tr>
<tr>
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#numberOfImages()">numberOfImages</a></code></div>
+ <p>How many images should be generated.</p>
</td>
</tr>
</tbody>
@@ -70,6 +74,39 @@
<div class="api-item"><a name="ImagenGenerationConfig(kotlin.String, kotlin.Int, com.google.firebase.vertexai.type.ImagenAspectRatio)"></a><a name="ImagenGenerationConfig-kotlin.String-kotlin.Int-com.google.firebase.vertexai.type.ImagenAspectRatio-"></a><a name="imagengenerationconfig"></a>
<h3 class="api-name" id="ImagenGenerationConfig(kotlin.String,kotlin.Int,com.google.firebase.vertexai.type.ImagenAspectRatio)">ImagenGenerationConfig</h3>
<pre class="api-signature no-pretty-print"><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#ImagenGenerationConfig(kotlin.String,kotlin.Int,com.google.firebase.vertexai.type.ImagenAspectRatio)">ImagenGenerationConfig</a>(<br> negativePrompt: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null,<br> numberOfImages: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a> = 1,<br> aspectRatio: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a>? = null<br>)</pre>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Parameters</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>negativePrompt: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null</code></td>
+ <td>
+ <p>This string contains things that should be explicitly be excluded from generated images.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>numberOfImages: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a> = 1</code></td>
+ <td>
+ <p>How many images should be generated.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>aspectRatio: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a>? = null</code></td>
+ <td>
+ <p>The aspect ratio of the generated images.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
</div>
<div class="list">
@@ -77,14 +114,17 @@
<div class="api-item"><a name="getAspectRatio()"></a><a name="setAspectRatio()"></a><a name="getAspectRatio--"></a><a name="setAspectRatio--"></a>
<h3 class="api-name" id="aspectRatio()">aspectRatio</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#aspectRatio()">aspectRatio</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a>?</pre>
+ <p>The aspect ratio of the generated images.</p>
</div>
<div class="api-item"><a name="getNegativePrompt()"></a><a name="setNegativePrompt()"></a><a name="getNegativePrompt--"></a><a name="setNegativePrompt--"></a>
<h3 class="api-name" id="negativePrompt()">negativePrompt</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#negativePrompt()">negativePrompt</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?</pre>
+ <p>This string contains things that should be explicitly be excluded from generated images.</p>
</div>
<div class="api-item"><a name="getNumberOfImages()"></a><a name="setNumberOfImages()"></a><a name="getNumberOfImages--"></a><a name="setNumberOfImages--"></a>
<h3 class="api-name" id="numberOfImages()">numberOfImages</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#numberOfImages()">numberOfImages</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></pre>
+ <p>How many images should be generated.</p>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenGenerationResponse.html 2025-01-07 19:39:03.934824603 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenGenerationResponse.html 2025-01-07 19:36:54.721326179 +0000
@@ -11,6 +11,7 @@
<pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationResponse.html">ImagenGenerationResponse</a><T : <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImageRepresentible.html">ImagenImageRepresentible</a>></pre>
</p>
<hr>
+ <p>Represents a response from Imagen call to ImageModel#generateImages</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -48,12 +49,14 @@
<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/ImagenGenerationResponse.html#filteredReason()">filteredReason</a></code></div>
+ <p>if fewer images were generated than were requested, this field will contain the reason they were filtered out.</p>
</td>
</tr>
<tr>
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><T></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationResponse.html#images()">images</a></code></div>
+ <p>contains the generated images</p>
</td>
</tr>
</tbody>
@@ -64,6 +67,33 @@
<div class="api-item"><a name="ImagenGenerationResponse(kotlin.collections.List, kotlin.String)"></a><a name="ImagenGenerationResponse-kotlin.collections.List-kotlin.String-"></a><a name="imagengenerationresponse"></a>
<h3 class="api-name" id="ImagenGenerationResponse(kotlin.collections.List,kotlin.String)">ImagenGenerationResponse</h3>
<pre class="api-signature no-pretty-print"><T : <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImageRepresentible.html">ImagenImageRepresentible</a>> <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationResponse.html#ImagenGenerationResponse(kotlin.collections.List,kotlin.String)">ImagenGenerationResponse</a>(<br> images: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><T>,<br> filteredReason: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?<br>)</pre>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Parameters</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>images: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><T></code></td>
+ <td>
+ <p>contains the generated images</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>filteredReason: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?</code></td>
+ <td>
+ <p>if fewer images were generated than were requested, this field will contain the reason they were filtered out.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
</div>
<div class="list">
@@ -71,10 +101,12 @@
<div class="api-item"><a name="getFilteredReason()"></a><a name="setFilteredReason()"></a><a name="getFilteredReason--"></a><a name="setFilteredReason--"></a>
<h3 class="api-name" id="filteredReason()">filteredReason</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationResponse.html#filteredReason()">filteredReason</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?</pre>
+ <p>if fewer images were generated than were requested, this field will contain the reason they were filtered out.</p>
</div>
<div class="api-item"><a name="getImages()"></a><a name="setImages()"></a><a name="getImages--"></a><a name="setImages--"></a>
<h3 class="api-name" id="images()">images</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationResponse.html#images()">images</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><T></pre>
+ <p>contains the generated images</p>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenImage.html 2025-01-07 19:39:03.937824614 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenImage.html 2025-01-07 19:36:54.724326190 +0000
@@ -11,6 +11,7 @@
<pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImage.html">ImagenImage</a> : <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImageRepresentible.html">ImagenImageRepresentible</a></pre>
</p>
<hr>
+ <p>Represents an abstract Imagen Image that is either contained inline or in Google Cloud Storage</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -69,18 +70,21 @@
<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/ImagenImage.html#data()">data</a></code></div>
+ <p>Contains the raw bytes of the image, mutually exclusive with <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImage.html#gcsUri()">gcsUri</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/ImagenImage.html#gcsUri()">gcsUri</a></code></div>
+ <p>Contains the gs:// uri for the image , mutually exclusive with <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImage.html#data()">data</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/ImagenImage.html#mimeType()">mimeType</a></code></div>
+ <p>Contains the mime type of the image eg.</p>
</td>
</tr>
</tbody>
@@ -91,6 +95,39 @@
<div class="api-item"><a name="ImagenImage(kotlin.ByteArray, kotlin.String, kotlin.String)"></a><a name="ImagenImage-kotlin.ByteArray-kotlin.String-kotlin.String-"></a><a name="imagenimage"></a>
<h3 class="api-name" id="ImagenImage(kotlin.ByteArray,kotlin.String,kotlin.String)">ImagenImage</h3>
<pre class="api-signature no-pretty-print"><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImage.html#ImagenImage(kotlin.ByteArray,kotlin.String,kotlin.String)">ImagenImage</a>(data: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a>?, gcsUri: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?, mimeType: <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>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Parameters</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>data: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a>?</code></td>
+ <td>
+ <p>Contains the raw bytes of the image, mutually exclusive with <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImage.html#<init>(kotlin.ByteArray,kotlin.String,kotlin.String)">gcsUri</a></code></p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>gcsUri: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?</code></td>
+ <td>
+ <p>Contains the gs:// uri for the image , mutually exclusive with <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImage.html#<init>(kotlin.ByteArray,kotlin.String,kotlin.String)">data</a></code></p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>mimeType: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
+ <td>
+ <p>Contains the mime type of the image eg. "image/png"</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
</div>
<div class="list">
@@ -105,14 +142,17 @@
<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/ImagenImage.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, mutually exclusive with <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImage.html#gcsUri()">gcsUri</a></code></p>
</div>
<div class="api-item"><a name="getGcsUri()"></a><a name="setGcsUri()"></a><a name="getGcsUri--"></a><a name="setGcsUri--"></a>
<h3 class="api-name" id="gcsUri()">gcsUri</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImage.html#gcsUri()">gcsUri</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?</pre>
+ <p>Contains the gs:// uri for the image , mutually exclusive with <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImage.html#data()">data</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/ImagenImage.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 eg. "image/png"</p>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenImageRepresentible.html 2025-01-07 19:39:03.934824603 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenImageRepresentible.html 2025-01-07 19:36:54.721326179 +0000
@@ -23,15 +23,21 @@
<tbody class="list">
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGCSImage.html">ImagenGCSImage</a></code></td>
- <td></td>
+ <td>
+ <p>Represents an Imagen Image that is contained in Google Cloud Storage.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImage.html">ImagenImage</a></code></td>
- <td></td>
+ <td>
+ <p>Represents an abstract Imagen Image that is either contained inline or in Google Cloud Storage</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html">ImagenInlineImage</a></code></td>
- <td></td>
+ <td>
+ <p>Represents an Imagen Image that is contained inline</p>
+ </td>
</tr>
</tbody>
</table>
@@ -39,6 +45,7 @@
</div>
</devsite-expandable> </div>
<hr>
+ <p>Interface representing images which can be passed into Imagen (for upscaling, editing, etc.)</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive"> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html 2025-01-07 19:39:03.937824614 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html 2025-01-07 19:36:54.724326190 +0000
@@ -11,6 +11,7 @@
<pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html">ImagenInlineImage</a> : <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImageRepresentible.html">ImagenImageRepresentible</a></pre>
</p>
<hr>
+ <p>Represents an Imagen Image that is contained inline</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -48,6 +49,7 @@
<td><code><a href="https://developer.android.com/reference/kotlin/android/graphics/Bitmap.html">Bitmap</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html#asBitmap()">asBitmap</a>()</code></div>
+ <p>Returns the image as an android OS native <code><a href="https://developer.android.com/reference/kotlin/android/graphics/Bitmap.html">Bitmap</a></code> so that it can be saved or sent to the UI.</p>
</td>
</tr>
<tr>
@@ -75,12 +77,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>
</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 eg.</p>
</td>
</tr>
</tbody>
@@ -91,6 +95,33 @@
<div class="api-item"><a name="ImagenInlineImage(kotlin.ByteArray, kotlin.String)"></a><a name="ImagenInlineImage-kotlin.ByteArray-kotlin.String-"></a><a name="imageninlineimage"></a>
<h3 class="api-name" id="ImagenInlineImage(kotlin.ByteArray,kotlin.String)">ImagenInlineImage</h3>
<pre class="api-signature no-pretty-print"><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html#ImagenInlineImage(kotlin.ByteArray,kotlin.String)">ImagenInlineImage</a>(data: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a>, mimeType: <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>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Parameters</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>data: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a></code></td>
+ <td>
+ <p>Contains the raw bytes of the image</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>mimeType: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
+ <td>
+ <p>Contains the mime type of the image eg. "image/png"</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
</div>
<div class="list">
@@ -98,6 +129,7 @@
<div class="api-item"><a name="asBitmap--"></a><a name="asbitmap"></a>
<h3 class="api-name" id="asBitmap()">asBitmap</h3>
<pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html#asBitmap()">asBitmap</a>(): <a href="https://developer.android.com/reference/kotlin/android/graphics/Bitmap.html">Bitmap</a></pre>
+ <p>Returns the image as an android OS native <code><a href="https://developer.android.com/reference/kotlin/android/graphics/Bitmap.html">Bitmap</a></code> so that it can be saved or sent to the UI.</p>
</div>
<div class="api-item"><a name="asImagenImage--"></a><a name="asimagenimage"></a>
<h3 class="api-name" id="asImagenImage()">asImagenImage</h3>
@@ -109,10 +141,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>
</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 eg. "image/png"</p>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenModelConfig.html 2025-01-07 19:39:03.936824610 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenModelConfig.html 2025-01-07 19:36:54.723326186 +0000
@@ -11,6 +11,7 @@
<pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenModelConfig.html">ImagenModelConfig</a></pre>
</p>
<hr>
+ <p>Contains extra configuration options for the Imagen model.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -28,12 +29,14 @@
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>?</code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenModelConfig.html#addWatermark()">addWatermark</a></code></div>
+ <p>If true, the image is invisibly watermarked as AI generated.</p>
</td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImageFormat.html">ImageFormat</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenModelConfig.html#imageFormat()">imageFormat</a></code></div>
+ <p>Specifies the encoding format for the image.</p>
</td>
</tr>
</tbody>
@@ -44,10 +47,12 @@
<div class="api-item"><a name="getAddWatermark()"></a><a name="setAddWatermark()"></a><a name="getAddWatermark--"></a><a name="setAddWatermark--"></a>
<h3 class="api-name" id="addWatermark()">addWatermark</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenModelConfig.html#addWatermark()">addWatermark</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>?</pre>
+ <p>If true, the image is invisibly watermarked as AI generated.</p>
</div>
<div class="api-item"><a name="getImageFormat()"></a><a name="setImageFormat()"></a><a name="getImageFormat--"></a><a name="setImageFormat--"></a>
<h3 class="api-name" id="imageFormat()">imageFormat</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenModelConfig.html#imageFormat()">imageFormat</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImageFormat.html">ImageFormat</a></pre>
+ <p>Specifies the encoding format for the image.</p>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilter.html 2025-01-07 19:39:03.933824599 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilter.html 2025-01-07 19:36:54.721326179 +0000
@@ -29,6 +29,7 @@
</table>
</div>
<hr>
+ <p>A filter used to prevent images from containing depictions of people or children.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -44,15 +45,21 @@
<tbody class="list">
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilter.html#ALLOW_ADULT">ALLOW_ADULT</a></code></td>
- <td></td>
+ <td>
+ <p>Filters out any images containing depictions of children.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilter.html#ALLOW_ALL">ALLOW_ALL</a></code></td>
- <td></td>
+ <td>
+ <p>Doesn't apply any filtering.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilter.html#BLOCK_ALL">BLOCK_ALL</a></code></td>
- <td></td>
+ <td>
+ <p>Filters out any images with depictions of people.</p>
+ </td>
</tr>
</tbody>
</table>
@@ -91,14 +98,17 @@
<div class="api-item">
<h3 class="api-name" id="ALLOW_ADULT">ALLOW_ADULT</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilter.html#ALLOW_ADULT">ImagenPersonFilter.ALLOW_ADULT</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilter.html">ImagenPersonFilter</a></pre>
+ <p>Filters out any images containing depictions of children.</p>
</div>
<div class="api-item">
<h3 class="api-name" id="ALLOW_ALL">ALLOW_ALL</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilter.html#ALLOW_ALL">ImagenPersonFilter.ALLOW_ALL</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilter.html">ImagenPersonFilter</a></pre>
+ <p>Doesn't apply any filtering.</p>
</div>
<div class="api-item">
<h3 class="api-name" id="BLOCK_ALL">BLOCK_ALL</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilter.html#BLOCK_ALL">ImagenPersonFilter.BLOCK_ALL</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilter.html">ImagenPersonFilter</a></pre>
+ <p>Filters out any images with depictions of people.</p>
</div>
</div>
<div class="list"> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilter.html 2025-01-07 19:39:03.935824607 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilter.html 2025-01-07 19:36:54.722326183 +0000
@@ -29,6 +29,7 @@
</table>
</div>
<hr>
+ <p>Used for safety filtering.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -44,15 +45,21 @@
<tbody class="list">
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilter.html#BLOCK_LOW_AND_ABOVE">BLOCK_LOW_AND_ABOVE</a></code></td>
- <td></td>
+ <td>
+ <p>Strongest filtering level, most strict blocking.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilter.html#BLOCK_MEDIUM_AND_ABOVE">BLOCK_MEDIUM_AND_ABOVE</a></code></td>
- <td></td>
+ <td>
+ <p>Block some problematic prompts and responses.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilter.html#BLOCK_ONLY_HIGH">BLOCK_ONLY_HIGH</a></code></td>
- <td></td>
+ <td>
+ <p>Reduces the number of requests blocked due to safety filters.</p>
+ </td>
</tr>
</tbody>
</table>
@@ -91,14 +98,17 @@
<div class="api-item">
<h3 class="api-name" id="BLOCK_LOW_AND_ABOVE">BLOCK_LOW_AND_ABOVE</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilter.html#BLOCK_LOW_AND_ABOVE">ImagenSafetyFilter.BLOCK_LOW_AND_ABOVE</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilter.html">ImagenSafetyFilter</a></pre>
+ <p>Strongest filtering level, most strict blocking.</p>
</div>
<div class="api-item">
<h3 class="api-name" id="BLOCK_MEDIUM_AND_ABOVE">BLOCK_MEDIUM_AND_ABOVE</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilter.html#BLOCK_MEDIUM_AND_ABOVE">ImagenSafetyFilter.BLOCK_MEDIUM_AND_ABOVE</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilter.html">ImagenSafetyFilter</a></pre>
+ <p>Block some problematic prompts and responses.</p>
</div>
<div class="api-item">
<h3 class="api-name" id="BLOCK_ONLY_HIGH">BLOCK_ONLY_HIGH</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilter.html#BLOCK_ONLY_HIGH">ImagenSafetyFilter.BLOCK_ONLY_HIGH</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilter.html">ImagenSafetyFilter</a></pre>
+ <p>Reduces the number of requests blocked due to safety filters. May increase objectionable content generated by Imagen.</p>
</div>
</div>
<div class="list"> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/package-summary.html 2025-01-07 19:39:03.934824603 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/package-summary.html 2025-01-07 19:36:54.722326183 +0000
@@ -16,7 +16,9 @@
<tbody class="list">
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImageRepresentible.html">ImagenImageRepresentible</a></code></td>
- <td></td>
+ <td>
+ <p>Interface representing images which can be passed into Imagen (for upscaling, editing, etc.)</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/Part.html">Part</a></code></td>
@@ -163,7 +165,9 @@
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImageFormat.html">ImageFormat</a></code></td>
- <td></td>
+ <td>
+ <p>Represents the format an image should be returned in.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagePart.html">ImagePart</a></code></td>
@@ -173,31 +177,45 @@
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImageSafetySettings.html">ImageSafetySettings</a></code></td>
- <td></td>
+ <td>
+ <p>A configuration for filtering unsafe content or images containing people.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGCSImage.html">ImagenGCSImage</a></code></td>
- <td></td>
+ <td>
+ <p>Represents an Imagen Image that is contained in Google Cloud Storage.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a></code></td>
- <td></td>
+ <td>
+ <p>Contains extra settings to configure image generation</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationResponse.html">ImagenGenerationResponse</a></code></td>
- <td></td>
+ <td>
+ <p>Represents a response from Imagen call to ImageModel#generateImages</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImage.html">ImagenImage</a></code></td>
- <td></td>
+ <td>
+ <p>Represents an abstract Imagen Image that is either contained inline or in Google Cloud Storage</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html">ImagenInlineImage</a></code></td>
- <td></td>
+ <td>
+ <p>Represents an Imagen Image that is contained inline</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenModelConfig.html">ImagenModelConfig</a></code></td>
- <td></td>
+ <td>
+ <p>Contains extra configuration options for the Imagen model.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/InlineDataPart.html">InlineDataPart</a></code></td>
@@ -363,15 +381,21 @@
<tbody class="list">
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a></code></td>
- <td></td>
+ <td>
+ <p>Represents the aspect ratio that the generated image should conform to.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilter.html">ImagenPersonFilter</a></code></td>
- <td></td>
+ <td>
+ <p>A filter used to prevent images from containing depictions of people or children.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilter.html">ImagenSafetyFilter</a></code></td>
- <td></td>
+ <td>
+ <p>Used for safety filtering.</p>
+ </td>
</tr>
</tbody>
</table> |
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.
No description provided.