Improve imagen Java API #6712
Open
Improve imagen Java API #6712
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
- Make the `ImagenGenerationConfig.Builder` follow the builder pattern - Mark companion object `ImagenImageFormat` methods as @JvmStatic for easier access
Javadoc Changes:--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html 2025-02-22 00:37:41.510089132 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html 2025-02-22 00:35:26.493129939 +0000
@@ -13,25 +13,6 @@
<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">
@@ -49,35 +30,30 @@
<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>
@@ -122,6 +98,41 @@
<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>
+ <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/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#setAddWatermark(kotlin.Boolean)">setAddWatermark</a>(boolean addWatermark)</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="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></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#setAspectRatio(com.google.firebase.vertexai.type.ImagenAspectRatio)">setAspectRatio</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/ImagenAspectRatio.html">ImagenAspectRatio</a> aspectRatio)</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="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></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#setImageFormat(com.google.firebase.vertexai.type.ImagenImageFormat)">setImageFormat</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/ImagenImageFormat.html">ImagenImageFormat</a> imageFormat)</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/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#setNegativePrompt(kotlin.String)">setNegativePrompt</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> negativePrompt)</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/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#setNumberOfImages(kotlin.Int)">setNumberOfImages</a>(int numberOfImages)</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>
</table>
</div>
@@ -130,27 +141,22 @@
<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">
@@ -168,6 +174,31 @@
<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 class="api-item"><a name="setAddWatermark-kotlin.Boolean-"></a><a name="setaddwatermark"></a>
+ <h3 class="api-name" id="setAddWatermark(kotlin.Boolean)">setAddWatermark</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.Builder.html">ImagenGenerationConfig.Builder</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#setAddWatermark(kotlin.Boolean)">setAddWatermark</a>(boolean addWatermark)</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="setAspectRatio-com.google.firebase.vertexai.type.ImagenAspectRatio-"></a><a name="setaspectratio"></a>
+ <h3 class="api-name" id="setAspectRatio(com.google.firebase.vertexai.type.ImagenAspectRatio)">setAspectRatio</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.Builder.html">ImagenGenerationConfig.Builder</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#setAspectRatio(com.google.firebase.vertexai.type.ImagenAspectRatio)">setAspectRatio</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/ImagenAspectRatio.html">ImagenAspectRatio</a> aspectRatio)</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="setImageFormat-com.google.firebase.vertexai.type.ImagenImageFormat-"></a><a name="setimageformat"></a>
+ <h3 class="api-name" id="setImageFormat(com.google.firebase.vertexai.type.ImagenImageFormat)">setImageFormat</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.Builder.html">ImagenGenerationConfig.Builder</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#setImageFormat(com.google.firebase.vertexai.type.ImagenImageFormat)">setImageFormat</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/ImagenImageFormat.html">ImagenImageFormat</a> imageFormat)</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="setNegativePrompt-kotlin.String-"></a><a name="setnegativeprompt"></a>
+ <h3 class="api-name" id="setNegativePrompt(kotlin.String)">setNegativePrompt</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.Builder.html">ImagenGenerationConfig.Builder</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#setNegativePrompt(kotlin.String)">setNegativePrompt</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> negativePrompt)</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="setNumberOfImages-kotlin.Int-"></a><a name="setnumberofimages"></a>
+ <h3 class="api-name" id="setNumberOfImages(kotlin.Int)">setNumberOfImages</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.Builder.html">ImagenGenerationConfig.Builder</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#setNumberOfImages(kotlin.Int)">setNumberOfImages</a>(int numberOfImages)</pre>
+ <p>See <code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html#numberOfImages()">ImagenGenerationConfig.numberOfImages</a></code>.</p>
+ </div>
</div>
</body>
</html>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html 2025-02-22 00:37:41.512089131 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html 2025-02-22 00:35:26.495129938 +0000
@@ -11,7 +11,6 @@
<pre>@<a href="/docs/reference/android/com/google/firebase/vertexai/type/PublicPreviewAPI.html">PublicPreviewAPI</a><br>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/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">
@@ -55,35 +54,30 @@
<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>
@@ -114,27 +108,22 @@
<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">
@@ -142,51 +131,6 @@
<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-02-22 00:37:41.513089130 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGenerationConfigKt.html 2025-02-22 00:35:26.496129937 +0000
@@ -30,6 +30,12 @@
<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>
+ <tr>
+ <td><code>static final void</code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfigKt.html#xx()">xx</a>()</code></div>
+ </td>
+ </tr>
</tbody>
</table>
</div>
@@ -42,6 +48,10 @@
<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 class="api-item"><a name="xx--"></a><a name="xx"></a>
+ <h3 class="api-name" id="xx()">xx</h3>
+ <pre class="api-signature no-pretty-print">public static final void <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfigKt.html#xx()">xx</a>()</pre>
+ </div>
</div>
</body>
</html>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenImageFormat.html 2025-02-22 00:37:41.510089132 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenImageFormat.html 2025-02-22 00:35:26.492129940 +0000
@@ -62,6 +62,35 @@
</tbody>
</table>
</div>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Public methods</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <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#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>
+ </table>
+ </div>
<div class="list">
<h2>Public fields</h2>
<div class="api-item"><a name="getCompressionQuality()"></a><a name="setCompressionQuality()"></a><a name="getCompressionQuality--"></a><a name="setCompressionQuality--"></a>
@@ -75,6 +104,40 @@
<p>A string (like <code>"image/jpeg"</code>) specifying the encoding MIME type of the image.</p>
</div>
</div>
+ <div class="list">
+ <h2>Public methods</h2>
+ <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>
</html>
--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/package-summary.html 2025-02-22 00:37:41.510089132 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/package-summary.html 2025-02-22 00:35:26.492129940 +0000
@@ -200,9 +200,7 @@
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a></code></td>
- <td>
- <p>Contains extra settings to configure image generation.</p>
- </td>
+ <td></td>
</tr>
<tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</a></code></td>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html 2025-02-22 00:37:41.518089128 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html 2025-02-22 00:35:26.502129934 +0000
@@ -13,25 +13,6 @@
<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">
@@ -72,6 +53,41 @@
<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>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#setAddWatermark(kotlin.Boolean)">setAddWatermark</a>(addWatermark: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</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/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#setAspectRatio(com.google.firebase.vertexai.type.ImagenAspectRatio)">setAspectRatio</a>(aspectRatio: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</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/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#setImageFormat(com.google.firebase.vertexai.type.ImagenImageFormat)">setImageFormat</a>(imageFormat: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</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="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#setNegativePrompt(kotlin.String)">setNegativePrompt</a>(negativePrompt: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</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="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#setNumberOfImages(kotlin.Int)">setNumberOfImages</a>(numberOfImages: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</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>
</table>
</div>
@@ -91,35 +107,30 @@
<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>
@@ -140,33 +151,53 @@
<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 class="api-item"><a name="setAddWatermark-kotlin.Boolean-"></a><a name="setaddwatermark"></a>
+ <h3 class="api-name" id="setAddWatermark(kotlin.Boolean)">setAddWatermark</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#setAddWatermark(kotlin.Boolean)">setAddWatermark</a>(addWatermark: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</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="setAspectRatio-com.google.firebase.vertexai.type.ImagenAspectRatio-"></a><a name="setaspectratio"></a>
+ <h3 class="api-name" id="setAspectRatio(com.google.firebase.vertexai.type.ImagenAspectRatio)">setAspectRatio</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#setAspectRatio(com.google.firebase.vertexai.type.ImagenAspectRatio)">setAspectRatio</a>(aspectRatio: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a>): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</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="setImageFormat-com.google.firebase.vertexai.type.ImagenImageFormat-"></a><a name="setimageformat"></a>
+ <h3 class="api-name" id="setImageFormat(com.google.firebase.vertexai.type.ImagenImageFormat)">setImageFormat</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#setImageFormat(com.google.firebase.vertexai.type.ImagenImageFormat)">setImageFormat</a>(imageFormat: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</a>): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</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="setNegativePrompt-kotlin.String-"></a><a name="setnegativeprompt"></a>
+ <h3 class="api-name" id="setNegativePrompt(kotlin.String)">setNegativePrompt</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#setNegativePrompt(kotlin.String)">setNegativePrompt</a>(negativePrompt: <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/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</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="setNumberOfImages-kotlin.Int-"></a><a name="setnumberofimages"></a>
+ <h3 class="api-name" id="setNumberOfImages(kotlin.Int)">setNumberOfImages</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html#setNumberOfImages(kotlin.Int)">setNumberOfImages</a>(numberOfImages: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</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>
<div class="list">
<h2>Public properties</h2>
<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-02-22 00:37:41.519089127 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html 2025-02-22 00:35:26.504129932 +0000
@@ -11,7 +11,6 @@
<pre>@<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/PublicPreviewAPI.html">PublicPreviewAPI</a><br>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/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">
@@ -91,35 +90,30 @@
<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>
@@ -137,51 +131,6 @@
<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">
@@ -189,27 +138,22 @@
<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/package-summary.html 2025-02-22 00:37:41.518089128 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/package-summary.html 2025-02-22 00:35:26.501129934 +0000
@@ -177,9 +177,7 @@
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a></code></td>
- <td>
- <p>Contains extra settings to configure image generation.</p>
- </td>
+ <td></td>
</tr>
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.Builder.html">ImagenGenerationConfig.Builder</a></code></td>
@@ -431,6 +429,12 @@
<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>
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/package-summary.html#xx()">xx</a>()</code></div>
+ </td>
+ </tr>
</tbody>
</table>
</div>
@@ -496,6 +500,10 @@
<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 class="api-item"><a name="xx--"></a><a name="xx"></a>
+ <h3 class="api-name" id="xx()">xx</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/package-summary.html#xx()">xx</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a></pre>
+ </div>
<h2>Extension functions</h2>
<div class="api-item"><a name="-com.google.firebase.vertexai.type.Part-.asFileDataOrNull--"></a><a name="asfiledataornull"></a>
<h3 class="api-name" id="(com.google.firebase.vertexai.type.Part).asFileDataOrNull()">asFileDataOrNull</h3> |
Generated by 🚫 Danger |
Coverage Report 1Affected ProductsNo changes between base commit (e37be5a) and merge commit (0e654bc).Test Logs |
Test Results 20 files - 1 014 20 suites - 1 014 12s ⏱️ - 34m 47s Results for commit 0332547. ± Comparison against base commit e37be5a. This pull request removes 5775 tests.♻️ This comment has been updated with latest results. |
|
The public api surface has changed for the subproject firebase-vertexai: Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly. |
Size Report 1Affected Products
Test Logs |
davidmotson
reviewed
Feb 21, 2025
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.kt
Outdated
Show resolved
Hide resolved
|
The public api surface has changed for the subproject firebase-vertexai: Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly. |
|
The public api surface has changed for the subproject firebase-vertexai: Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly. |
davidmotson
approved these changes
Feb 22, 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.
ImagenGenerationConfig.Builderfollow the builder patternImagenImageFormatmethods as @JvmStatic for easier access