-
Notifications
You must be signed in to change notification settings - Fork 588
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
27
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
+338
−0
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
Generated by 🚫 Danger |
Javadoc Changes:--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/FirebaseVertexAI.html 2025-01-29 19:55:55.687120903 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/FirebaseVertexAI.html 2025-01-29 19:53:48.047034605 +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/ImagenModel.html">ImagenModel</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/FirebaseVertexAI.html#imagenModel(kotlin.String,com.google.firebase.vertexai.type.ImagenGenerationConfig,com.google.firebase.vertexai.type.ImagenSafetySettings,com.google.firebase.vertexai.type.RequestOptions)">imagenModel</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/ImagenGenerationConfig.html">ImagenGenerationConfig</a> generationConfig,<br> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetySettings.html">ImagenSafetySettings</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/ImagenModel.html">ImagenModel</a></code> given the provided parameters.</p>
</td>
</tr>
</tbody>
@@ -222,6 +223,67 @@
<div class="api-item"><a name="imagenModel(kotlin.String, com.google.firebase.vertexai.type.ImagenGenerationConfig, com.google.firebase.vertexai.type.ImagenSafetySettings, com.google.firebase.vertexai.type.RequestOptions)"></a><a name="imagenModel-kotlin.String-com.google.firebase.vertexai.type.ImagenGenerationConfig-com.google.firebase.vertexai.type.ImagenSafetySettings-com.google.firebase.vertexai.type.RequestOptions-"></a><a name="imagenmodel"></a>
<h3 class="api-name" id="imagenModel(kotlin.String,com.google.firebase.vertexai.type.ImagenGenerationConfig,com.google.firebase.vertexai.type.ImagenSafetySettings,com.google.firebase.vertexai.type.RequestOptions)">imagenModel</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/ImagenModel.html">ImagenModel</a> <a href="/docs/reference/android/com/google/firebase/vertexai/FirebaseVertexAI.html#imagenModel(kotlin.String,com.google.firebase.vertexai.type.ImagenGenerationConfig,com.google.firebase.vertexai.type.ImagenSafetySettings,com.google.firebase.vertexai.type.RequestOptions)">imagenModel</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/ImagenGenerationConfig.html">ImagenGenerationConfig</a> generationConfig,<br> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetySettings.html">ImagenSafetySettings</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/ImagenModel.html">ImagenModel</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/ImagenGenerationConfig.html">ImagenGenerationConfig</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/ImagenSafetySettings.html">ImagenSafetySettings</a> safetySettings</code></td>
+ <td>
+ <p>The safety bounds the model will abide by 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/ImagenModel.html">ImagenModel</a></code></td>
+ <td>
+ <p>The initialized <code><a href="/docs/reference/android/com/google/firebase/vertexai/ImagenModel.html">ImagenModel</a></code> instance.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/ImagenModel.html 2025-01-29 19:55:55.686120902 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/ImagenModel.html 2025-01-29 19:53:48.046034604 +0000
@@ -11,6 +11,7 @@
<pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/ImagenModel.html">ImagenModel</a></pre>
</p>
<hr>
+ <p>Represents a generative 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/ImagenModel.html#generateImages(kotlin.String)">generateImages</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)</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/ImagenModel.html#generateImages(kotlin.String,kotlin.String)">generateImages</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="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></div>
+ <p>Generates an image, storing the result in Google Cloud Storage and returning a URL</p>
</td>
</tr>
</tbody>
@@ -44,10 +47,60 @@
<div class="api-item"><a name="generateImages-kotlin.String-"></a><a name="generateimages"></a>
<h3 class="api-name" id="generateImages(kotlin.String)">generateImages</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/ImagenModel.html#generateImages(kotlin.String)">generateImages</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)</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 input(s) given to the model as a prompt.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
<div class="api-item"><a name="generateImages(kotlin.String, kotlin.String)"></a><a name="generateImages-kotlin.String-kotlin.String-"></a><a name="generateimages"></a>
<h3 class="api-name" id="generateImages(kotlin.String,kotlin.String)">generateImages</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/ImagenModel.html#generateImages(kotlin.String,kotlin.String)">generateImages</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="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)</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 input(s) given to the model as a prompt.</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 where in Google Cloud Storage to store the image (for example, a specific bucket or folder).</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-29 19:55:55.679120897 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/package-summary.html 2025-01-29 19:53:48.036034595 +0000
@@ -38,7 +38,9 @@
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/ImagenModel.html">ImagenModel</a></code></td>
- <td></td>
+ <td>
+ <p>Represents a generative 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/ImagenAspectRatio.html 2025-01-29 19:55:55.680120898 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html 2025-01-29 19:53:48.037034596 +0000
@@ -11,6 +11,7 @@
<pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a></pre>
</p>
<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">
@@ -48,30 +49,35 @@
<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/ImagenAspectRatio.html">ImagenAspectRatio</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.Companion.html#LANDSCAPE_16x9()">LANDSCAPE_16x9</a></code></div>
+ <p>A landscape image in 16:9, the aspect ratio of modern monitors and phone screens.</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/ImagenAspectRatio.html">ImagenAspectRatio</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.Companion.html#LANDSCAPE_4x3()">LANDSCAPE_4x3</a></code></div>
+ <p>A landscape image in 4:3, the aspect ratio of older TVs.</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/ImagenAspectRatio.html">ImagenAspectRatio</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.Companion.html#PORTRAIT_3x4()">PORTRAIT_3x4</a></code></div>
+ <p>A portrait image in 3:4, the aspect ratio of older TVs.</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/ImagenAspectRatio.html">ImagenAspectRatio</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.Companion.html#PORTRAIT_9x16()">PORTRAIT_9x16</a></code></div>
+ <p>A portrait image in 9:16, the aspect ratio of modern monitors and phone screens.</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/ImagenAspectRatio.html">ImagenAspectRatio</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.Companion.html#SQUARE_1x1()">SQUARE_1x1</a></code></div>
+ <p>A square image, useful for icons, profile pictures, etc.</p>
</td>
</tr>
</tbody>
@@ -82,22 +88,27 @@
<div class="api-item"><a name="getLANDSCAPE_16x9()"></a><a name="setLANDSCAPE_16x9()"></a><a name="getLANDSCAPE_16x9--"></a><a name="setLANDSCAPE_16x9--"></a>
<h3 class="api-name" id="LANDSCAPE_16x9()">LANDSCAPE_16x9</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/ImagenAspectRatio.html">ImagenAspectRatio</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.Companion.html#LANDSCAPE_16x9()">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"><a name="getLANDSCAPE_4x3()"></a><a name="setLANDSCAPE_4x3()"></a><a name="getLANDSCAPE_4x3--"></a><a name="setLANDSCAPE_4x3--"></a>
<h3 class="api-name" id="LANDSCAPE_4x3()">LANDSCAPE_4x3</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/ImagenAspectRatio.html">ImagenAspectRatio</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.Companion.html#LANDSCAPE_4x3()">LANDSCAPE_4x3</a></pre>
+ <p>A landscape image in 4:3, the aspect ratio of older TVs.</p>
</div>
<div class="api-item"><a name="getPORTRAIT_3x4()"></a><a name="setPORTRAIT_3x4()"></a><a name="getPORTRAIT_3x4--"></a><a name="setPORTRAIT_3x4--"></a>
<h3 class="api-name" id="PORTRAIT_3x4()">PORTRAIT_3x4</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/ImagenAspectRatio.html">ImagenAspectRatio</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.Companion.html#PORTRAIT_3x4()">PORTRAIT_3x4</a></pre>
+ <p>A portrait image in 3:4, the aspect ratio of older TVs.</p>
</div>
<div class="api-item"><a name="getPORTRAIT_9x16()"></a><a name="setPORTRAIT_9x16()"></a><a name="getPORTRAIT_9x16--"></a><a name="setPORTRAIT_9x16--"></a>
<h3 class="api-name" id="PORTRAIT_9x16()">PORTRAIT_9x16</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/ImagenAspectRatio.html">ImagenAspectRatio</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.Companion.html#PORTRAIT_9x16()">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"><a name="getSQUARE_1x1()"></a><a name="setSQUARE_1x1()"></a><a name="getSQUARE_1x1--"></a><a name="setSQUARE_1x1--"></a>
<h3 class="api-name" id="SQUARE_1x1()">SQUARE_1x1</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/ImagenAspectRatio.html">ImagenAspectRatio</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.Companion.html#SQUARE_1x1()">SQUARE_1x1</a></pre>
+ <p>A square image, useful for icons, profile pictures, etc.</p>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGCSImage.html 2025-01-29 19:55:55.682120899 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGCSImage.html 2025-01-29 19:53:48.039034598 +0000
@@ -11,6 +11,7 @@
<pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGCSImage.html">ImagenGCSImage</a></pre>
</p>
<hr>
+ <p>Represents an Imagen-generated 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 <code>gs://</code> 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 (for example, <code>"image/png"</code>).</p>
</td>
</tr>
</tbody>
@@ -44,10 +47,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 <code>gs://</code> 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 (for example, <code>"image/png"</code>).</p>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html 2025-01-29 19:55:55.681120899 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html 2025-01-29 19:53:48.039034598 +0000
@@ -11,6 +11,27 @@
<pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</a></pre>
</p>
<hr>
+ <p>Builder for creating a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a></code>.</p>
+ <p>This is mainly intended for Java interop. For Kotlin, use <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/package-summary.html#imagenGenerationConfig(kotlin.Function1)">imagenGenerationConfig</a></code> for a more idiomatic experience.</p>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">See also</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/package-summary.html#imagenGenerationConfig(kotlin.Function1)">imagenGenerationConfig</a></code></td>
+ <td></td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -28,30 +49,35 @@
<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/ImagenGenerationConfig.Builder.html#addWatermark()">addWatermark</a></code></div>
+ <p>See <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#addWatermark()">ImagenGenerationConfig.addWatermark</a></code></p>
</td>
</tr>
<tr>
<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.Builder.html#aspectRatio()">aspectRatio</a></code></div>
+ <p>See <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#aspectRatio()">ImagenGenerationConfig.aspectRatio</a></code>.</p>
</td>
</tr>
<tr>
<td><code>final <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#imageFormat()">imageFormat</a></code></div>
+ <p>See <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#imageFormat()">ImagenGenerationConfig.imageFormat</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/ImagenGenerationConfig.Builder.html#negativePrompt()">negativePrompt</a></code></div>
+ <p>See <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#negativePrompt()">ImagenGenerationConfig.negativePrompt</a></code>.</p>
</td>
</tr>
<tr>
<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/ImagenGenerationConfig.Builder.html#numberOfImages()">numberOfImages</a></code></div>
+ <p>See <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#numberOfImages()">ImagenGenerationConfig.numberOfImages</a></code>.</p>
</td>
</tr>
</tbody>
@@ -93,6 +119,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/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#build()">build</a>()</code></div>
+ <p>Alternative casing for <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</a></code>:</p>
</td>
</tr>
</tbody>
@@ -103,22 +130,27 @@
<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/ImagenGenerationConfig.Builder.html#addWatermark()">addWatermark</a></pre>
+ <p>See <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#addWatermark()">ImagenGenerationConfig.addWatermark</a></code></p>
</div>
<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.Builder.html#aspectRatio()">aspectRatio</a></pre>
+ <p>See <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#aspectRatio()">ImagenGenerationConfig.aspectRatio</a></code>.</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="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#imageFormat()">imageFormat</a></pre>
+ <p>See <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#imageFormat()">ImagenGenerationConfig.imageFormat</a></code></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.Builder.html#negativePrompt()">negativePrompt</a></pre>
+ <p>See <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#negativePrompt()">ImagenGenerationConfig.negativePrompt</a></code>.</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 <a href="https://developer.android.com/reference/kotlin/java/lang/Integer.html">Integer</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#numberOfImages()">numberOfImages</a></pre>
+ <p>See <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#numberOfImages()">ImagenGenerationConfig.numberOfImages</a></code>.</p>
</div>
</div>
<div class="list">
@@ -133,6 +165,8 @@
<div class="api-item"><a name="build--"></a><a name="build"></a>
<h3 class="api-name" id="build()">build</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/ImagenGenerationConfig.html">ImagenGenerationConfig</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#build()">build</a>()</pre>
+ <p>Alternative casing for <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</a></code>:</p>
+ <pre class="prettyprint">val config = GenerationConfig.builder()</pre>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html 2025-01-29 19:55:55.682120899 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html 2025-01-29 19:53:48.039034598 +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">
@@ -27,6 +28,7 @@
<tr>
<td>
<div><code>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</a></code></div>
+ <p>Builder for creating a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a></code>.</p>
</td>
</tr>
<tr>
@@ -53,30 +55,35 @@
<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/ImagenGenerationConfig.html#addWatermark()">addWatermark</a></code></div>
+ <p>Adds an invisible watermark to mark the image as AI generated.</p>
</td>
</tr>
<tr>
<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="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#imageFormat()">imageFormat</a></code></div>
+ <p>The file format/compression 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 excluded from generated images.</p>
</td>
</tr>
<tr>
<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/ImagenGenerationConfig.html#numberOfImages()">numberOfImages</a></code></div>
+ <p>How many images should be generated.</p>
</td>
</tr>
</tbody>
@@ -107,22 +114,27 @@
<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/ImagenGenerationConfig.html#addWatermark()">addWatermark</a></pre>
+ <p>Adds an invisible watermark to mark the image as AI generated.</p>
</div>
<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="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="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#imageFormat()">imageFormat</a></pre>
+ <p>The file format/compression 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 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 <a href="https://developer.android.com/reference/kotlin/java/lang/Integer.html">Integer</a> <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">
@@ -130,6 +142,51 @@
<div class="api-item"><a name="ImagenGenerationConfig(kotlin.String, kotlin.Int, com.google.firebase.vertexai.type.ImagenAspectRatio, com.google.firebase.vertexai.type.ImagenImageFormat, kotlin.Boolean)"></a><a name="ImagenGenerationConfig-kotlin.String-kotlin.Int-com.google.firebase.vertexai.type.ImagenAspectRatio-com.google.firebase.vertexai.type.ImagenImageFormat-kotlin.Boolean-"></a><a name="imagengenerationconfig"></a>
<h3 class="api-name" id="ImagenGenerationConfig(kotlin.String,kotlin.Int,com.google.firebase.vertexai.type.ImagenAspectRatio,com.google.firebase.vertexai.type.ImagenImageFormat,kotlin.Boolean)">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,com.google.firebase.vertexai.type.ImagenImageFormat,kotlin.Boolean)">ImagenGenerationConfig</a>(<br> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> negativePrompt,<br> <a href="https://developer.android.com/reference/kotlin/java/lang/Integer.html">Integer</a> numberOfImages,<br> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a> aspectRatio,<br> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</a> imageFormat,<br> <a href="https://developer.android.com/reference/kotlin/java/lang/Boolean.html">Boolean</a> addWatermark<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 excluded from generated images.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/Integer.html">Integer</a> 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>
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</a> imageFormat</code></td>
+ <td>
+ <p>The file format/compression of the generated images.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/Boolean.html">Boolean</a> addWatermark</code></td>
+ <td>
+ <p>Adds an invisible watermark to mark the image as AI generated.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGenerationConfigKt.html 2025-01-29 19:55:55.683120900 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGenerationConfigKt.html 2025-01-29 19:53:48.040034599 +0000
@@ -27,6 +27,7 @@
<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/ImagenGenerationConfig.html">ImagenGenerationConfig</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfigKt.html#imagenGenerationConfig(kotlin.Function1)">imagenGenerationConfig</a>(<br> @<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-extension-function-type/index.html">ExtensionFunctionType</a> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> Function1<@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</a>, <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>> init<br>)</code></div>
+ <p>Helper method to construct a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a></code> in a DSL-like manner.</p>
</td>
</tr>
</tbody>
@@ -37,6 +38,9 @@
<div class="api-item"><a name="imagenGenerationConfig-kotlin.Function1-"></a><a name="imagengenerationconfig"></a>
<h3 class="api-name" id="imagenGenerationConfig(kotlin.Function1)">imagenGenerationConfig</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/ImagenGenerationConfig.html">ImagenGenerationConfig</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfigKt.html#imagenGenerationConfig(kotlin.Function1)">imagenGenerationConfig</a>(<br> @<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-extension-function-type/index.html">ExtensionFunctionType</a> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> Function1<@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</a>, <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>> init<br>)</pre>
+ <p>Helper method to construct a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a></code> in a DSL-like manner.</p>
+ <p>Example Usage:</p>
+ <pre class="prettyprint">imagenGenerationConfig {<br> negativePrompt = "People, black and white, painting"<br> numberOfImages = 1<br> aspectRatio = ImagenAspecRatio.SQUARE_1x1<br> imageFormat = ImagenImageFormat.png()<br> addWatermark = false<br>}</pre>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGenerationResponse.html 2025-01-29 19:55:55.680120898 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGenerationResponse.html 2025-01-29 19:53:48.037034596 +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="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a>></pre>
</p>
<hr>
+ <p>Represents a response from a call to ImagenModel#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>
@@ -44,10 +47,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>
</body> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenImageFormat.Companion.html 2025-01-29 19:55:55.682120899 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenImageFormat.Companion.html 2025-01-29 19:53:48.039034598 +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/ImagenImageFormat.html">ImagenImageFormat</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImageFormat.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/ImagenImageFormat.html">ImagenImageFormat</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/ImagenImageFormat.html">ImagenImageFormat</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImageFormat.Companion.html#png()">png</a>()</code></div>
+ <p>An <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</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/ImagenImageFormat.html">ImagenImageFormat</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImageFormat.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/ImagenImageFormat.html">ImagenImageFormat</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 the quality of the image; a lower number means 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/ImagenImageFormat.html">ImagenImageFormat</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImageFormat.Companion.html#png()">png</a>()</pre>
+ <p>An <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</a></code> representing a PNG image</p>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenImageFormat.html 2025-01-29 19:55:55.685120901 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenImageFormat.html 2025-01-29 19:53:48.044034602 +0000
@@ -11,6 +11,7 @@
<pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</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/ImagenImageFormat.html#compressionQuality()">compressionQuality</a></code></div>
+ <p>an int (1-100) representing the quality of the image; a lower number means 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/ImagenImageFormat.html#mimeType()">mimeType</a></code></div>
+ <p>A string (like <code>"image/jpeg"</code>) specifying the encoding MIME type 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/ImagenImageFormat.html#compressionQuality()">compressionQuality</a></pre>
+ <p>an int (1-100) representing the quality of the image; a lower number means the image is permitted to be lower quality to reduce size. This parameter is not relevant for every MIME type.</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/ImagenImageFormat.html#mimeType()">mimeType</a></pre>
+ <p>A string (like <code>"image/jpeg"</code>) specifying the encoding MIME type of the image.</p>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenInlineImage.html 2025-01-29 19:55:55.684120901 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenInlineImage.html 2025-01-29 19:53:48.043034602 +0000
@@ -11,6 +11,7 @@
<pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenInlineImage.html">ImagenInlineImage</a></pre>
</p>
<hr>
+ <p>Represents an Imagen-generated image that is contained inline</p>
<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 (for example, <code>"image/png"</code>)</p>
</td>
</tr>
</tbody>
@@ -55,6 +58,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>
</tbody>
@@ -65,10 +69,12 @@
<div class="api-item"><a name="getData()"></a><a name="setData()"></a><a name="getData--"></a><a name="setData--"></a>
<h3 class="api-name" id="data()">data</h3>
<pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> byte[] <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenInlineImage.html#data()">data</a></pre>
+ <p>Contains the raw bytes of the image</p>
</div>
<div class="api-item"><a name="getMimeType()"></a><a name="setMimeType()"></a><a name="getMimeType--"></a><a name="setMimeType--"></a>
<h3 class="api-name" id="mimeType()">mimeType</h3>
<pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenInlineImage.html#mimeType()">mimeType</a></pre>
+ <p>Contains the MIME type of the image (for example, <code>"image/png"</code>)</p>
</div>
</div>
<div class="list">
@@ -76,6 +82,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>
</body> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.html 2025-01-29 19:55:55.685120901 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.html 2025-01-29 19:53:48.045034603 +0000
@@ -11,6 +11,7 @@
<pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.html">ImagenPersonFilterLevel</a></pre>
</p>
<hr>
+ <p>A filter used to prevent images from containing depictions of children or people.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -48,18 +49,21 @@
<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/ImagenPersonFilterLevel.html">ImagenPersonFilterLevel</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.Companion.html#ALLOW_ADULT()">ALLOW_ADULT</a></code></div>
+ <p>Filters out any images containing depictions of children.</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/ImagenPersonFilterLevel.html">ImagenPersonFilterLevel</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.Companion.html#ALLOW_ALL()">ALLOW_ALL</a></code></div>
+ <p>No filters applied.</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/ImagenPersonFilterLevel.html">ImagenPersonFilterLevel</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.Companion.html#BLOCK_ALL()">BLOCK_ALL</a></code></div>
+ <p>Filters out any images containing depictions of people.</p>
</td>
</tr>
</tbody>
@@ -70,14 +74,17 @@
<div class="api-item"><a name="getALLOW_ADULT()"></a><a name="setALLOW_ADULT()"></a><a name="getALLOW_ADULT--"></a><a name="setALLOW_ADULT--"></a>
<h3 class="api-name" id="ALLOW_ADULT()">ALLOW_ADULT</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/ImagenPersonFilterLevel.html">ImagenPersonFilterLevel</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.Companion.html#ALLOW_ADULT()">ALLOW_ADULT</a></pre>
+ <p>Filters out any images containing depictions of children.</p>
</div>
<div class="api-item"><a name="getALLOW_ALL()"></a><a name="setALLOW_ALL()"></a><a name="getALLOW_ALL--"></a><a name="setALLOW_ALL--"></a>
<h3 class="api-name" id="ALLOW_ALL()">ALLOW_ALL</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/ImagenPersonFilterLevel.html">ImagenPersonFilterLevel</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.Companion.html#ALLOW_ALL()">ALLOW_ALL</a></pre>
+ <p>No filters applied.</p>
</div>
<div class="api-item"><a name="getBLOCK_ALL()"></a><a name="setBLOCK_ALL()"></a><a name="getBLOCK_ALL--"></a><a name="setBLOCK_ALL--"></a>
<h3 class="api-name" id="BLOCK_ALL()">BLOCK_ALL</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/ImagenPersonFilterLevel.html">ImagenPersonFilterLevel</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.Companion.html#BLOCK_ALL()">BLOCK_ALL</a></pre>
+ <p>Filters out any images containing depictions of people.</p>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.html 2025-01-29 19:55:55.684120901 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.html 2025-01-29 19:53:48.042034601 +0000
@@ -11,6 +11,7 @@
<pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a></pre>
</p>
<hr>
+ <p>Used for safety filtering.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -48,24 +49,28 @@
<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/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.Companion.html#BLOCK_LOW_AND_ABOVE()">BLOCK_LOW_AND_ABOVE</a></code></div>
+ <p>Strongest filtering level, most strict blocking.</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/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.Companion.html#BLOCK_MEDIUM_AND_ABOVE()">BLOCK_MEDIUM_AND_ABOVE</a></code></div>
+ <p>Block some problematic prompts and responses.</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/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.Companion.html#BLOCK_NONE()">BLOCK_NONE</a></code></div>
+ <p>Turns off all optional safety filters.</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/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.Companion.html#BLOCK_ONLY_HIGH()">BLOCK_ONLY_HIGH</a></code></div>
+ <p>Reduces the number of requests blocked due to safety filters.</p>
</td>
</tr>
</tbody>
@@ -76,18 +81,22 @@
<div class="api-item"><a name="getBLOCK_LOW_AND_ABOVE()"></a><a name="setBLOCK_LOW_AND_ABOVE()"></a><a name="getBLOCK_LOW_AND_ABOVE--"></a><a name="setBLOCK_LOW_AND_ABOVE--"></a>
<h3 class="api-name" id="BLOCK_LOW_AND_ABOVE()">BLOCK_LOW_AND_ABOVE</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/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.Companion.html#BLOCK_LOW_AND_ABOVE()">BLOCK_LOW_AND_ABOVE</a></pre>
+ <p>Strongest filtering level, most strict blocking.</p>
</div>
<div class="api-item"><a name="getBLOCK_MEDIUM_AND_ABOVE()"></a><a name="setBLOCK_MEDIUM_AND_ABOVE()"></a><a name="getBLOCK_MEDIUM_AND_ABOVE--"></a><a name="setBLOCK_MEDIUM_AND_ABOVE--"></a>
<h3 class="api-name" id="BLOCK_MEDIUM_AND_ABOVE()">BLOCK_MEDIUM_AND_ABOVE</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/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.Companion.html#BLOCK_MEDIUM_AND_ABOVE()">BLOCK_MEDIUM_AND_ABOVE</a></pre>
+ <p>Block some problematic prompts and responses.</p>
</div>
<div class="api-item"><a name="getBLOCK_NONE()"></a><a name="setBLOCK_NONE()"></a><a name="getBLOCK_NONE--"></a><a name="setBLOCK_NONE--"></a>
<h3 class="api-name" id="BLOCK_NONE()">BLOCK_NONE</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/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.Companion.html#BLOCK_NONE()">BLOCK_NONE</a></pre>
+ <p>Turns off all optional safety filters.</p>
</div>
<div class="api-item"><a name="getBLOCK_ONLY_HIGH()"></a><a name="setBLOCK_ONLY_HIGH()"></a><a name="getBLOCK_ONLY_HIGH--"></a><a name="setBLOCK_ONLY_HIGH--"></a>
<h3 class="api-name" id="BLOCK_ONLY_HIGH()">BLOCK_ONLY_HIGH</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/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.Companion.html#BLOCK_ONLY_HIGH()">BLOCK_ONLY_HIGH</a></pre>
+ <p>Reduces the number of requests blocked due to safety filters. May increase objectionable content generated by the Imagen model.</p>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenSafetySettings.html 2025-01-29 19:55:55.681120899 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenSafetySettings.html 2025-01-29 19:53:48.038034597 +0000
@@ -11,6 +11,7 @@
<pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetySettings.html">ImagenSafetySettings</a></pre>
</p>
<hr>
+ <p>A configuration for filtering unsafe content or images containing people.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -37,6 +38,33 @@
<div class="api-item"><a name="ImagenSafetySettings(com.google.firebase.vertexai.type.ImagenSafetyFilterLevel, com.google.firebase.vertexai.type.ImagenPersonFilterLevel)"></a><a name="ImagenSafetySettings-com.google.firebase.vertexai.type.ImagenSafetyFilterLevel-com.google.firebase.vertexai.type.ImagenPersonFilterLevel-"></a><a name="imagensafetysettings"></a>
<h3 class="api-name" id="ImagenSafetySettings(com.google.firebase.vertexai.type.ImagenSafetyFilterLevel,com.google.firebase.vertexai.type.ImagenPersonFilterLevel)">ImagenSafetySettings</h3>
<pre class="api-signature no-pretty-print">public <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetySettings.html#ImagenSafetySettings(com.google.firebase.vertexai.type.ImagenSafetyFilterLevel,com.google.firebase.vertexai.type.ImagenPersonFilterLevel)">ImagenSafetySettings</a>(<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/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a> safetyFilterLevel,<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/ImagenPersonFilterLevel.html">ImagenPersonFilterLevel</a> personFilterLevel<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="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a> safetyFilterLevel</code></td>
+ <td>
+ <p>Used to filter unsafe content.</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/ImagenPersonFilterLevel.html">ImagenPersonFilterLevel</a> personFilterLevel</code></td>
+ <td>
+ <p>Used to filter images containing people.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/package-summary.html 2025-01-29 19:55:55.681120899 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/package-summary.html 2025-01-29 19:53:48.038034597 +0000
@@ -173,19 +173,27 @@
</tr>
<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/ImagenGCSImage.html">ImagenGCSImage</a></code></td>
- <td></td>
+ <td>
+ <p>Represents an Imagen-generated 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/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</a></code></td>
- <td></td>
+ <td>
+ <p>Builder for creating a <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a></code>.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfigKt.html">ImagenGenerationConfigKt</a></code></td>
@@ -193,27 +201,39 @@
</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 a call to ImagenModel#generateImages</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</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/ImagenInlineImage.html">ImagenInlineImage</a></code></td>
- <td></td>
+ <td>
+ <p>Represents an Imagen-generated image that is contained inline</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.html">ImagenPersonFilterLevel</a></code></td>
- <td></td>
+ <td>
+ <p>A filter used to prevent images from containing depictions of children or people.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a></code></td>
- <td></td>
+ <td>
+ <p>Used for safety filtering.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetySettings.html">ImagenSafetySettings</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/InlineDataPart.html">InlineDataPart</a></code></td> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/FirebaseVertexAI.html 2025-01-29 19:55:55.694120907 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/FirebaseVertexAI.html 2025-01-29 19:53:48.054034611 +0000
@@ -86,6 +86,7 @@
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImagenModel.html">ImagenModel</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/FirebaseVertexAI.html#imagenModel(kotlin.String,com.google.firebase.vertexai.type.ImagenGenerationConfig,com.google.firebase.vertexai.type.ImagenSafetySettings,com.google.firebase.vertexai.type.RequestOptions)">imagenModel</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/ImagenGenerationConfig.html">ImagenGenerationConfig</a>?,<br> safetySettings: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetySettings.html">ImagenSafetySettings</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/ImagenModel.html">ImagenModel</a></code> given the provided parameters.</p>
</td>
</tr>
</tbody>
@@ -220,6 +221,67 @@
<div class="api-item"><a name="imagenModel(kotlin.String, com.google.firebase.vertexai.type.ImagenGenerationConfig, com.google.firebase.vertexai.type.ImagenSafetySettings, com.google.firebase.vertexai.type.RequestOptions)"></a><a name="imagenModel-kotlin.String-com.google.firebase.vertexai.type.ImagenGenerationConfig-com.google.firebase.vertexai.type.ImagenSafetySettings-com.google.firebase.vertexai.type.RequestOptions-"></a><a name="imagenmodel"></a>
<h3 class="api-name" id="imagenModel(kotlin.String,com.google.firebase.vertexai.type.ImagenGenerationConfig,com.google.firebase.vertexai.type.ImagenSafetySettings,com.google.firebase.vertexai.type.RequestOptions)">imagenModel</h3>
<pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/FirebaseVertexAI.html#imagenModel(kotlin.String,com.google.firebase.vertexai.type.ImagenGenerationConfig,com.google.firebase.vertexai.type.ImagenSafetySettings,com.google.firebase.vertexai.type.RequestOptions)">imagenModel</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/ImagenGenerationConfig.html">ImagenGenerationConfig</a>? = null,<br> safetySettings: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetySettings.html">ImagenSafetySettings</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/ImagenModel.html">ImagenModel</a></pre>
+ <p>Instantiates a new <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImagenModel.html">ImagenModel</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/ImagenGenerationConfig.html">ImagenGenerationConfig</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/ImagenSafetySettings.html">ImagenSafetySettings</a>? = null</code></td>
+ <td>
+ <p>The safety bounds the model will abide by 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/ImagenModel.html">ImagenModel</a></code></td>
+ <td>
+ <p>The initialized <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImagenModel.html">ImagenModel</a></code> instance.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/ImagenModel.html 2025-01-29 19:55:55.693120906 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/ImagenModel.html 2025-01-29 19:53:48.053034611 +0000
@@ -11,6 +11,7 @@
<pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImagenModel.html">ImagenModel</a></pre>
</p>
<hr>
+ <p>Represents a generative 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/ImagenModel.html#generateImages(kotlin.String)">generateImages</a>(prompt: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</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/ImagenModel.html#generateImages(kotlin.String,kotlin.String)">generateImages</a>(prompt: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, gcsUri: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
+ <p>Generates an image, storing the result in Google Cloud Storage and returning a URL</p>
</td>
</tr>
</tbody>
@@ -44,10 +47,60 @@
<div class="api-item"><a name="generateImages-kotlin.String-"></a><a name="generateimages"></a>
<h3 class="api-name" id="generateImages(kotlin.String)">generateImages</h3>
<pre class="api-signature no-pretty-print">suspend fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImagenModel.html#generateImages(kotlin.String)">generateImages</a>(prompt: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</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 input(s) given to the model as a prompt.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
<div class="api-item"><a name="generateImages(kotlin.String, kotlin.String)"></a><a name="generateImages-kotlin.String-kotlin.String-"></a><a name="generateimages"></a>
<h3 class="api-name" id="generateImages(kotlin.String,kotlin.String)">generateImages</h3>
<pre class="api-signature no-pretty-print">suspend fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImagenModel.html#generateImages(kotlin.String,kotlin.String)">generateImages</a>(prompt: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, gcsUri: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</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/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 input(s) given to the model as a prompt.</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 where in Google Cloud Storage to store the image (for example, a specific bucket or folder).</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-29 19:55:55.688120903 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/package-summary.html 2025-01-29 19:53:48.047034605 +0000
@@ -34,7 +34,9 @@
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImagenModel.html">ImagenModel</a></code></td>
- <td></td>
+ <td>
+ <p>Represents a generative 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/ImagenAspectRatio.html 2025-01-29 19:55:55.689120904 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html 2025-01-29 19:53:48.048034606 +0000
@@ -11,6 +11,7 @@
<pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a></pre>
</p>
<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">
@@ -28,30 +29,35 @@
<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/ImagenAspectRatio.Companion.html#LANDSCAPE_16x9()">LANDSCAPE_16x9</a></code></div>
+ <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">ImagenAspectRatio</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.Companion.html#LANDSCAPE_4x3()">LANDSCAPE_4x3</a></code></div>
+ <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">ImagenAspectRatio</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.Companion.html#PORTRAIT_3x4()">PORTRAIT_3x4</a></code></div>
+ <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">ImagenAspectRatio</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.Companion.html#PORTRAIT_9x16()">PORTRAIT_9x16</a></code></div>
+ <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">ImagenAspectRatio</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.Companion.html#SQUARE_1x1()">SQUARE_1x1</a></code></div>
+ <p>A square image, useful for icons, profile pictures, etc.</p>
</td>
</tr>
</tbody>
@@ -62,22 +68,27 @@
<div class="api-item"><a name="getLANDSCAPE_16x9()"></a><a name="setLANDSCAPE_16x9()"></a><a name="getLANDSCAPE_16x9--"></a><a name="setLANDSCAPE_16x9--"></a>
<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.Companion.html#LANDSCAPE_16x9()">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"><a name="getLANDSCAPE_4x3()"></a><a name="setLANDSCAPE_4x3()"></a><a name="getLANDSCAPE_4x3--"></a><a name="setLANDSCAPE_4x3--"></a>
<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.Companion.html#LANDSCAPE_4x3()">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"><a name="getPORTRAIT_3x4()"></a><a name="setPORTRAIT_3x4()"></a><a name="getPORTRAIT_3x4--"></a><a name="setPORTRAIT_3x4--"></a>
<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.Companion.html#PORTRAIT_3x4()">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"><a name="getPORTRAIT_9x16()"></a><a name="setPORTRAIT_9x16()"></a><a name="getPORTRAIT_9x16--"></a><a name="setPORTRAIT_9x16--"></a>
<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.Companion.html#PORTRAIT_9x16()">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"><a name="getSQUARE_1x1()"></a><a name="setSQUARE_1x1()"></a><a name="getSQUARE_1x1--"></a><a name="setSQUARE_1x1--"></a>
<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.Companion.html#SQUARE_1x1()">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>
</body> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenGCSImage.html 2025-01-29 19:55:55.690120905 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenGCSImage.html 2025-01-29 19:53:48.049034607 +0000
@@ -11,6 +11,7 @@
<pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGCSImage.html">ImagenGCSImage</a></pre>
</p>
<hr>
+ <p>Represents an Imagen-generated 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><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 <code>gs://</code> 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 (for example, <code>"image/png"</code>).</p>
</td>
</tr>
</tbody>
@@ -44,10 +47,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 <code>gs://</code> 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 (for example, <code>"image/png"</code>).</p>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html 2025-01-29 19:55:55.690120905 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html 2025-01-29 19:53:48.049034607 +0000
@@ -11,6 +11,27 @@
<pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</a></pre>
</p>
<hr>
+ <p>Builder for creating a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a></code>.</p>
+ <p>This is mainly intended for Java interop. For Kotlin, use <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/package-summary.html#imagenGenerationConfig(kotlin.Function1)">imagenGenerationConfig</a></code> for a more idiomatic experience.</p>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">See also</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/package-summary.html#imagenGenerationConfig(kotlin.Function1)">imagenGenerationConfig</a></code></td>
+ <td></td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -48,6 +69,7 @@
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#build()">build</a>()</code></div>
+ <p>Alternative casing for <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</a></code>:</p>
</td>
</tr>
</tbody>
@@ -69,30 +91,35 @@
<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/ImagenGenerationConfig.Builder.html#addWatermark()">addWatermark</a></code></div>
+ <p>See <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#addWatermark()">ImagenGenerationConfig.addWatermark</a></code></p>
</td>
</tr>
<tr>
<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.Builder.html#aspectRatio()">aspectRatio</a></code></div>
+ <p>See <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#aspectRatio()">ImagenGenerationConfig.aspectRatio</a></code>.</p>
</td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</a>?</code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#imageFormat()">imageFormat</a></code></div>
+ <p>See <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#imageFormat()">ImagenGenerationConfig.imageFormat</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/ImagenGenerationConfig.Builder.html#negativePrompt()">negativePrompt</a></code></div>
+ <p>See <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#negativePrompt()">ImagenGenerationConfig.negativePrompt</a></code>.</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.Builder.html#numberOfImages()">numberOfImages</a></code></div>
+ <p>See <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#numberOfImages()">ImagenGenerationConfig.numberOfImages</a></code>.</p>
</td>
</tr>
</tbody>
@@ -110,6 +137,8 @@
<div class="api-item"><a name="build--"></a><a name="build"></a>
<h3 class="api-name" id="build()">build</h3>
<pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#build()">build</a>(): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a></pre>
+ <p>Alternative casing for <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</a></code>:</p>
+ <pre class="prettyprint">val config = GenerationConfig.builder()</pre>
</div>
</div>
<div class="list">
@@ -117,22 +146,27 @@
<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">var <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#addWatermark()">addWatermark</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>?</pre>
+ <p>See <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#addWatermark()">ImagenGenerationConfig.addWatermark</a></code></p>
</div>
<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">var <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#aspectRatio()">aspectRatio</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a>?</pre>
+ <p>See <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#aspectRatio()">ImagenGenerationConfig.aspectRatio</a></code>.</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">var <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#imageFormat()">imageFormat</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</a>?</pre>
+ <p>See <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#imageFormat()">ImagenGenerationConfig.imageFormat</a></code></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">var <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#negativePrompt()">negativePrompt</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?</pre>
+ <p>See <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#negativePrompt()">ImagenGenerationConfig.negativePrompt</a></code>.</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">var <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#numberOfImages()">numberOfImages</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>?</pre>
+ <p>See <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#numberOfImages()">ImagenGenerationConfig.numberOfImages</a></code>.</p>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html 2025-01-29 19:55:55.690120905 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html 2025-01-29 19:53:48.050034608 +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">
@@ -27,6 +28,7 @@
<tr>
<td>
<div><code>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</a></code></div>
+ <p>Builder for creating a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a></code>.</p>
</td>
</tr>
</tbody>
@@ -89,30 +91,35 @@
<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/ImagenGenerationConfig.html#addWatermark()">addWatermark</a></code></div>
+ <p>Adds an invisible watermark to mark the image as AI generated.</p>
</td>
</tr>
<tr>
<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="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</a>?</code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#imageFormat()">imageFormat</a></code></div>
+ <p>The file format/compression 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 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>
@@ -130,6 +137,51 @@
<div class="api-item"><a name="ImagenGenerationConfig(kotlin.String, kotlin.Int, com.google.firebase.vertexai.type.ImagenAspectRatio, com.google.firebase.vertexai.type.ImagenImageFormat, kotlin.Boolean)"></a><a name="ImagenGenerationConfig-kotlin.String-kotlin.Int-com.google.firebase.vertexai.type.ImagenAspectRatio-com.google.firebase.vertexai.type.ImagenImageFormat-kotlin.Boolean-"></a><a name="imagengenerationconfig"></a>
<h3 class="api-name" id="ImagenGenerationConfig(kotlin.String,kotlin.Int,com.google.firebase.vertexai.type.ImagenAspectRatio,com.google.firebase.vertexai.type.ImagenImageFormat,kotlin.Boolean)">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,com.google.firebase.vertexai.type.ImagenImageFormat,kotlin.Boolean)">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> imageFormat: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</a>? = null,<br> addWatermark: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</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 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>
+ <tr>
+ <td><code>imageFormat: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</a>? = null</code></td>
+ <td>
+ <p>The file format/compression of the generated images.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>addWatermark: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>? = null</code></td>
+ <td>
+ <p>Adds an invisible watermark to mark the image as AI generated.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
</div>
<div class="list">
@@ -137,22 +189,27 @@
<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/ImagenGenerationConfig.html#addWatermark()">addWatermark</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>?</pre>
+ <p>Adds an invisible watermark to mark the image as AI generated.</p>
</div>
<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="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/ImagenGenerationConfig.html#imageFormat()">imageFormat</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</a>?</pre>
+ <p>The file format/compression 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 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-29 19:55:55.688120903 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenGenerationResponse.html 2025-01-29 19:53:48.048034606 +0000
@@ -11,6 +11,7 @@
<pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationResponse.html">ImagenGenerationResponse</a><T : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?></pre>
</p>
<hr>
+ <p>Represents a response from a call to ImagenModel#generateImages</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/-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>
@@ -44,10 +47,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/ImagenImageFormat.html 2025-01-29 19:55:55.692120906 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenImageFormat.html 2025-01-29 19:53:48.052034610 +0000
@@ -11,6 +11,7 @@
<pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</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/ImagenImageFormat.html">ImagenImageFormat</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImageFormat.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/ImagenImageFormat.html">ImagenImageFormat</a></code> representing a JPEG image.</p>
</td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImageFormat.Companion.html#png()">png</a>()</code></div>
+ <p>An <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</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/ImagenImageFormat.html#compressionQuality()">compressionQuality</a></code></div>
+ <p>an int (1-100) representing the quality of the image; a lower number means 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/ImagenImageFormat.html#mimeType()">mimeType</a></code></div>
+ <p>A string (like <code>"image/jpeg"</code>) specifying the encoding MIME type 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/ImagenImageFormat.Companion.html#jpeg(kotlin.Int)">jpeg</a>(compressionQuality: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>? = null): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</a></pre>
+ <p>An <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</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>? = null</code></td>
+ <td>
+ <p>an int (1-100) representing the quality of the image; a lower number means 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/ImagenImageFormat.Companion.html#png()">png</a>(): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</a></pre>
+ <p>An <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</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/ImagenImageFormat.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 the quality of the image; a lower number means the image is permitted to be lower quality to reduce size. This parameter is not relevant for every MIME type.</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/ImagenImageFormat.html#mimeType()">mimeType</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></pre>
+ <p>A string (like <code>"image/jpeg"</code>) specifying the encoding MIME type of the image.</p>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html 2025-01-29 19:55:55.692120906 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html 2025-01-29 19:53:48.052034610 +0000
@@ -11,6 +11,7 @@
<pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html">ImagenInlineImage</a></pre>
</p>
<hr>
+ <p>Represents an Imagen-generated image that is contained inline</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -28,6 +29,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>
</tbody>
@@ -49,12 +51,14 @@
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html#data()">data</a></code></div>
+ <p>Contains the raw bytes of the image</p>
</td>
</tr>
<tr>
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html#mimeType()">mimeType</a></code></div>
+ <p>Contains the MIME type of the image (for example, <code>"image/png"</code>)</p>
</td>
</tr>
</tbody>
@@ -65,6 +69,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>
<div class="list">
@@ -72,10 +77,12 @@
<div class="api-item"><a name="getData()"></a><a name="setData()"></a><a name="getData--"></a><a name="setData--"></a>
<h3 class="api-name" id="data()">data</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html#data()">data</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a></pre>
+ <p>Contains the raw bytes of the image</p>
</div>
<div class="api-item"><a name="getMimeType()"></a><a name="setMimeType()"></a><a name="getMimeType--"></a><a name="setMimeType--"></a>
<h3 class="api-name" id="mimeType()">mimeType</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html#mimeType()">mimeType</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></pre>
+ <p>Contains the MIME type of the image (for example, <code>"image/png"</code>)</p>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.html 2025-01-29 19:55:55.692120906 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.html 2025-01-29 19:53:48.052034610 +0000
@@ -11,6 +11,7 @@
<pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.html">ImagenPersonFilterLevel</a></pre>
</p>
<hr>
+ <p>A filter used to prevent images from containing depictions of children or people.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -28,18 +29,21 @@
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.html">ImagenPersonFilterLevel</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.Companion.html#ALLOW_ADULT()">ALLOW_ADULT</a></code></div>
+ <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/ImagenPersonFilterLevel.html">ImagenPersonFilterLevel</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.Companion.html#ALLOW_ALL()">ALLOW_ALL</a></code></div>
+ <p>No filters applied.</p>
</td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.html">ImagenPersonFilterLevel</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.Companion.html#BLOCK_ALL()">BLOCK_ALL</a></code></div>
+ <p>Filters out any images containing depictions of people.</p>
</td>
</tr>
</tbody>
@@ -50,14 +54,17 @@
<div class="api-item"><a name="getALLOW_ADULT()"></a><a name="setALLOW_ADULT()"></a><a name="getALLOW_ADULT--"></a><a name="setALLOW_ADULT--"></a>
<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/ImagenPersonFilterLevel.Companion.html#ALLOW_ADULT()">ALLOW_ADULT</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.html">ImagenPersonFilterLevel</a></pre>
+ <p>Filters out any images containing depictions of children.</p>
</div>
<div class="api-item"><a name="getALLOW_ALL()"></a><a name="setALLOW_ALL()"></a><a name="getALLOW_ALL--"></a><a name="setALLOW_ALL--"></a>
<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/ImagenPersonFilterLevel.Companion.html#ALLOW_ALL()">ALLOW_ALL</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.html">ImagenPersonFilterLevel</a></pre>
+ <p>No filters applied.</p>
</div>
<div class="api-item"><a name="getBLOCK_ALL()"></a><a name="setBLOCK_ALL()"></a><a name="getBLOCK_ALL--"></a><a name="setBLOCK_ALL--"></a>
<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/ImagenPersonFilterLevel.Companion.html#BLOCK_ALL()">BLOCK_ALL</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.html">ImagenPersonFilterLevel</a></pre>
+ <p>Filters out any images containing depictions of people.</p>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.html 2025-01-29 19:55:55.691120905 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.html 2025-01-29 19:53:48.051034609 +0000
@@ -11,6 +11,7 @@
<pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a></pre>
</p>
<hr>
+ <p>Used for safety filtering.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -28,24 +29,28 @@
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.Companion.html#BLOCK_LOW_AND_ABOVE()">BLOCK_LOW_AND_ABOVE</a></code></div>
+ <p>Strongest filtering level, most strict blocking.</p>
</td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.Companion.html#BLOCK_MEDIUM_AND_ABOVE()">BLOCK_MEDIUM_AND_ABOVE</a></code></div>
+ <p>Block some problematic prompts and responses.</p>
</td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.Companion.html#BLOCK_NONE()">BLOCK_NONE</a></code></div>
+ <p>Turns off all optional safety filters.</p>
</td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.Companion.html#BLOCK_ONLY_HIGH()">BLOCK_ONLY_HIGH</a></code></div>
+ <p>Reduces the number of requests blocked due to safety filters.</p>
</td>
</tr>
</tbody>
@@ -56,18 +61,22 @@
<div class="api-item"><a name="getBLOCK_LOW_AND_ABOVE()"></a><a name="setBLOCK_LOW_AND_ABOVE()"></a><a name="getBLOCK_LOW_AND_ABOVE--"></a><a name="setBLOCK_LOW_AND_ABOVE--"></a>
<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/ImagenSafetyFilterLevel.Companion.html#BLOCK_LOW_AND_ABOVE()">BLOCK_LOW_AND_ABOVE</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a></pre>
+ <p>Strongest filtering level, most strict blocking.</p>
</div>
<div class="api-item"><a name="getBLOCK_MEDIUM_AND_ABOVE()"></a><a name="setBLOCK_MEDIUM_AND_ABOVE()"></a><a name="getBLOCK_MEDIUM_AND_ABOVE--"></a><a name="setBLOCK_MEDIUM_AND_ABOVE--"></a>
<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/ImagenSafetyFilterLevel.Companion.html#BLOCK_MEDIUM_AND_ABOVE()">BLOCK_MEDIUM_AND_ABOVE</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a></pre>
+ <p>Block some problematic prompts and responses.</p>
</div>
<div class="api-item"><a name="getBLOCK_NONE()"></a><a name="setBLOCK_NONE()"></a><a name="getBLOCK_NONE--"></a><a name="setBLOCK_NONE--"></a>
<h3 class="api-name" id="BLOCK_NONE()">BLOCK_NONE</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.Companion.html#BLOCK_NONE()">BLOCK_NONE</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a></pre>
+ <p>Turns off all optional safety filters.</p>
</div>
<div class="api-item"><a name="getBLOCK_ONLY_HIGH()"></a><a name="setBLOCK_ONLY_HIGH()"></a><a name="getBLOCK_ONLY_HIGH--"></a><a name="setBLOCK_ONLY_HIGH--"></a>
<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/ImagenSafetyFilterLevel.Companion.html#BLOCK_ONLY_HIGH()">BLOCK_ONLY_HIGH</a>: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a></pre>
+ <p>Reduces the number of requests blocked due to safety filters. May increase objectionable content generated by the Imagen model.</p>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenSafetySettings.html 2025-01-29 19:55:55.689120904 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenSafetySettings.html 2025-01-29 19:53:48.049034607 +0000
@@ -11,6 +11,7 @@
<pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetySettings.html">ImagenSafetySettings</a></pre>
</p>
<hr>
+ <p>A configuration for filtering unsafe content or images containing people.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -37,6 +38,33 @@
<div class="api-item"><a name="ImagenSafetySettings(com.google.firebase.vertexai.type.ImagenSafetyFilterLevel, com.google.firebase.vertexai.type.ImagenPersonFilterLevel)"></a><a name="ImagenSafetySettings-com.google.firebase.vertexai.type.ImagenSafetyFilterLevel-com.google.firebase.vertexai.type.ImagenPersonFilterLevel-"></a><a name="imagensafetysettings"></a>
<h3 class="api-name" id="ImagenSafetySettings(com.google.firebase.vertexai.type.ImagenSafetyFilterLevel,com.google.firebase.vertexai.type.ImagenPersonFilterLevel)">ImagenSafetySettings</h3>
<pre class="api-signature no-pretty-print"><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetySettings.html#ImagenSafetySettings(com.google.firebase.vertexai.type.ImagenSafetyFilterLevel,com.google.firebase.vertexai.type.ImagenPersonFilterLevel)">ImagenSafetySettings</a>(<br> safetyFilterLevel: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a>,<br> personFilterLevel: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.html">ImagenPersonFilterLevel</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>safetyFilterLevel: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a></code></td>
+ <td>
+ <p>Used to filter unsafe content.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>personFilterLevel: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.html">ImagenPersonFilterLevel</a></code></td>
+ <td>
+ <p>Used to filter images containing people.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
</div>
</div>
</body> --- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/package-summary.html 2025-01-29 19:55:55.689120904 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/package-summary.html 2025-01-29 19:53:48.049034607 +0000
@@ -165,43 +165,63 @@
</tr>
<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/ImagenGCSImage.html">ImagenGCSImage</a></code></td>
- <td></td>
+ <td>
+ <p>Represents an Imagen-generated 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/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</a></code></td>
- <td></td>
+ <td>
+ <p>Builder for creating a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a></code>.</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 a call to ImagenModel#generateImages</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</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/ImagenInlineImage.html">ImagenInlineImage</a></code></td>
- <td></td>
+ <td>
+ <p>Represents an Imagen-generated image that is contained inline</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.html">ImagenPersonFilterLevel</a></code></td>
- <td></td>
+ <td>
+ <p>A filter used to prevent images from containing depictions of children or people.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a></code></td>
- <td></td>
+ <td>
+ <p>Used for safety filtering.</p>
+ </td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetySettings.html">ImagenSafetySettings</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/InlineDataPart.html">InlineDataPart</a></code></td>
@@ -387,6 +407,7 @@
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/package-summary.html#imagenGenerationConfig(kotlin.Function1)">imagenGenerationConfig</a>(init: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</a>.() <span style="white-space: nowrap;">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>)</code></div>
+ <p>Helper method to construct a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a></code> in a DSL-like manner.</p>
</td>
</tr>
</tbody>
@@ -450,6 +471,9 @@
<div class="api-item"><a name="imagenGenerationConfig-kotlin.Function1-"></a><a name="imagengenerationconfig"></a>
<h3 class="api-name" id="imagenGenerationConfig(kotlin.Function1)">imagenGenerationConfig</h3>
<pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/package-summary.html#imagenGenerationConfig(kotlin.Function1)">imagenGenerationConfig</a>(init: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</a>.() <span style="white-space: nowrap;">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a></pre>
+ <p>Helper method to construct a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a></code> in a DSL-like manner.</p>
+ <p>Example Usage:</p>
+ <pre class="prettyprint">imagenGenerationConfig {<br> negativePrompt = "People, black and white, painting"<br> numberOfImages = 1<br> aspectRatio = ImagenAspecRatio.SQUARE_1x1<br> imageFormat = ImagenImageFormat.png()<br> addWatermark = false<br>}</pre>
</div>
<h2>Extension functions</h2>
<div class="api-item"><a name="-com.google.firebase.vertexai.type.Part-.asFileDataOrNull--"></a><a name="asfiledataornull"></a> |
rlazo
reviewed
Jan 28, 2025
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/ImageModel.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/ImageModel.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/ImageModel.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/ImageModel.kt
Outdated
Show resolved
Hide resolved
rachelsaunders
requested changes
Jan 28, 2025
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/FirebaseVertexAI.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/ImagenModel.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/ImagenModel.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/ImagenGenerationResponse.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.kt
Outdated
Show resolved
Hide resolved
…/FirebaseVertexAI.kt Co-authored-by: rachelsaunders <[email protected]>
…/ImagenModel.kt Co-authored-by: rachelsaunders <[email protected]>
…/ImagenModel.kt Co-authored-by: rachelsaunders <[email protected]>
…/type/ImagenGenerationConfig.kt Co-authored-by: rachelsaunders <[email protected]>
…/type/ImagenInlineImage.kt Co-authored-by: rachelsaunders <[email protected]>
…/type/ImagenPersonFilterLevel.kt Co-authored-by: rachelsaunders <[email protected]>
…/type/ImagenSafetyFilterLevel.kt Co-authored-by: rachelsaunders <[email protected]>
…/type/ImagenPersonFilterLevel.kt Co-authored-by: rachelsaunders <[email protected]>
…/type/ImagenImage.kt Co-authored-by: rachelsaunders <[email protected]>
…/type/ImagenImage.kt Co-authored-by: rachelsaunders <[email protected]>
rachelsaunders
requested changes
Jan 29, 2025
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.kt
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/ImagenImageFormat.kt
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/ImagenModel.kt
Outdated
Show resolved
Hide resolved
rachelsaunders
requested changes
Jan 29, 2025
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.kt
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/ImagenGCSImage.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/ImagenGCSImage.kt
Outdated
Show resolved
Hide resolved
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/ImagenGCSImage.kt
Outdated
Show resolved
Hide resolved
…/type/ImagenGCSImage.kt Co-authored-by: rachelsaunders <[email protected]>
…/type/ImagenGenerationConfig.kt Co-authored-by: rachelsaunders <[email protected]>
Vertex AI Mock Responses Check
|
…/type/ImagenGCSImage.kt Co-authored-by: rachelsaunders <[email protected]>
rachelsaunders
approved these changes
Jan 29, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.