make a public preview annotation for Imagen #6668
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Vertex AI Mock Responses Check
|
Generated by 🚫 Danger |
Javadoc Changes:--- /home/runner/diff/original/firebase-kotlindoc/android/client/firebase-vertexai/_toc.yaml 2025-02-04 19:45:10.341120258 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/client/firebase-vertexai/_toc.yaml 2025-02-04 19:43:02.028342836 +0000
@@ -171,4 +171,10 @@
- title: "UnsupportedUserLocationException"
path: "/docs/reference/android/com/google/firebase/vertexai/type/UnsupportedUserLocationException.html"
+ - title: "Annotations"
+
+ section:
+ - title: "PublicPreviewAPI"
+ path: "/docs/reference/android/com/google/firebase/vertexai/type/PublicPreviewAPI.html"
+
--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/FirebaseVertexAI.html 2025-02-04 19:45:10.349120328 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/FirebaseVertexAI.html 2025-02-04 19:43:02.037342966 +0000
@@ -90,7 +90,7 @@
<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/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>
+ <div><code>@<a href="/docs/reference/android/com/google/firebase/vertexai/type/PublicPreviewAPI.html">PublicPreviewAPI</a><br><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>
@@ -222,7 +222,7 @@
</div>
<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>
+ <pre class="api-signature no-pretty-print">@<a href="/docs/reference/android/com/google/firebase/vertexai/type/PublicPreviewAPI.html">PublicPreviewAPI</a><br>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">--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/ImagenModel.html 2025-02-04 19:45:10.348120320 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/ImagenModel.html 2025-02-04 19:43:02.036342951 +0000
@@ -8,7 +8,7 @@
<div id="metadata-info-block"></div>
<h1>ImagenModel</h1>
<p>
- <pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/ImagenModel.html">ImagenModel</a></pre>
+ <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/ImagenModel.html">ImagenModel</a></pre>
</p>
<hr>
<p>Represents a generative model (like Imagen), capable of generating images based on various input types.</p>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/java/ImagenModelFutures.html 2025-02-04 19:45:10.349120328 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/java/ImagenModelFutures.html 2025-02-04 19:43:02.037342966 +0000
@@ -8,7 +8,7 @@
<div id="metadata-info-block"></div>
<h1>ImagenModelFutures</h1>
<p>
- <pre>public abstract class <a href="/docs/reference/android/com/google/firebase/vertexai/java/ImagenModelFutures.html">ImagenModelFutures</a></pre>
+ <pre>@<a href="/docs/reference/android/com/google/firebase/vertexai/type/PublicPreviewAPI.html">PublicPreviewAPI</a><br>public abstract class <a href="/docs/reference/android/com/google/firebase/vertexai/java/ImagenModelFutures.html">ImagenModelFutures</a></pre>
</p>
<hr>
<p>Wrapper class providing Java compatible methods for <code><a href="/docs/reference/android/com/google/firebase/vertexai/ImagenModel.html">ImagenModel</a></code>.</p>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html 2025-02-04 19:45:10.342120267 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html 2025-02-04 19:43:02.029342850 +0000
@@ -8,7 +8,7 @@
<div id="metadata-info-block"></div>
<h1>ImagenAspectRatio</h1>
<p>
- <pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a></pre>
+ <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/ImagenAspectRatio.html">ImagenAspectRatio</a></pre>
</p>
<hr>
<p>Represents the aspect ratio that the generated image should conform to.</p>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGCSImage.html 2025-02-04 19:45:10.343120276 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGCSImage.html 2025-02-04 19:43:02.030342865 +0000
@@ -8,7 +8,7 @@
<div id="metadata-info-block"></div>
<h1>ImagenGCSImage</h1>
<p>
- <pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGCSImage.html">ImagenGCSImage</a></pre>
+ <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/ImagenGCSImage.html">ImagenGCSImage</a></pre>
</p>
<hr>
<p>Represents an Imagen-generated image that is contained in Google Cloud Storage.</p>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html 2025-02-04 19:45:10.344120285 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html 2025-02-04 19:43:02.031342879 +0000
@@ -8,7 +8,7 @@
<div id="metadata-info-block"></div>
<h1>ImagenGenerationConfig</h1>
<p>
- <pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a></pre>
+ <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>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGenerationConfigKt.html 2025-02-04 19:45:10.345120293 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGenerationConfigKt.html 2025-02-04 19:43:02.032342893 +0000
@@ -26,7 +26,7 @@
<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/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>
+ <div><code>@<a href="/docs/reference/android/com/google/firebase/vertexai/type/PublicPreviewAPI.html">PublicPreviewAPI</a><br><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>
@@ -37,7 +37,7 @@
<h2>Public methods</h2>
<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>
+ <pre class="api-signature no-pretty-print">@<a href="/docs/reference/android/com/google/firebase/vertexai/type/PublicPreviewAPI.html">PublicPreviewAPI</a><br>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>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGenerationResponse.html 2025-02-04 19:45:10.342120267 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenGenerationResponse.html 2025-02-04 19:43:02.028342836 +0000
@@ -8,7 +8,7 @@
<div id="metadata-info-block"></div>
<h1>ImagenGenerationResponse</h1>
<p>
- <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>
+ <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/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>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenImageFormat.html 2025-02-04 19:45:10.347120311 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenImageFormat.html 2025-02-04 19:43:02.034342922 +0000
@@ -8,7 +8,7 @@
<div id="metadata-info-block"></div>
<h1>ImagenImageFormat</h1>
<p>
- <pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</a></pre>
+ <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/ImagenImageFormat.html">ImagenImageFormat</a></pre>
</p>
<hr>
<p>Represents the format an image should be returned in.</p>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenInlineImage.html 2025-02-04 19:45:10.346120302 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenInlineImage.html 2025-02-04 19:43:02.034342922 +0000
@@ -8,7 +8,7 @@
<div id="metadata-info-block"></div>
<h1>ImagenInlineImage</h1>
<p>
- <pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenInlineImage.html">ImagenInlineImage</a></pre>
+ <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/ImagenInlineImage.html">ImagenInlineImage</a></pre>
</p>
<hr>
<p>Represents an Imagen-generated image that is contained inline</p>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.html 2025-02-04 19:45:10.347120311 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.html 2025-02-04 19:43:02.035342936 +0000
@@ -8,7 +8,7 @@
<div id="metadata-info-block"></div>
<h1>ImagenPersonFilterLevel</h1>
<p>
- <pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.html">ImagenPersonFilterLevel</a></pre>
+ <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/ImagenPersonFilterLevel.html">ImagenPersonFilterLevel</a></pre>
</p>
<hr>
<p>A filter used to prevent images from containing depictions of children or people.</p>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.html 2025-02-04 19:45:10.346120302 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.html 2025-02-04 19:43:02.033342908 +0000
@@ -8,7 +8,7 @@
<div id="metadata-info-block"></div>
<h1>ImagenSafetyFilterLevel</h1>
<p>
- <pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a></pre>
+ <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/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a></pre>
</p>
<hr>
<p>Used for safety filtering.</p>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenSafetySettings.html 2025-02-04 19:45:10.343120276 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenSafetySettings.html 2025-02-04 19:43:02.030342865 +0000
@@ -8,7 +8,7 @@
<div id="metadata-info-block"></div>
<h1>ImagenSafetySettings</h1>
<p>
- <pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenSafetySettings.html">ImagenSafetySettings</a></pre>
+ <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/ImagenSafetySettings.html">ImagenSafetySettings</a></pre>
</p>
<hr>
<p>A configuration for filtering unsafe content or images containing people.</p>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/PublicPreviewAPI.html 1970-01-01 00:00:00.000000000 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/PublicPreviewAPI.html 2025-02-04 19:43:02.035342936 +0000
@@ -0,0 +1,44 @@
+<html devsite="true">
+ <head>
+ <title>PublicPreviewAPI</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/android/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>PublicPreviewAPI</h1>
+ <p>
+ <pre>@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-retention/index.html">Retention</a>(value = AnnotationRetention.BINARY)<br>@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-requires-opt-in/index.html">RequiresOptIn</a>(level = RequiresOptIn.Level.ERROR, message = "This API is currently experimental and in public preview and may change in behavior in backwards-incompatible ways without notice.")<br>public annotation <a href="/docs/reference/android/com/google/firebase/vertexai/type/PublicPreviewAPI.html">PublicPreviewAPI</a></pre>
+ </p>
+ <hr>
+ <h2>Summary</h2>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Public constructors</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/PublicPreviewAPI.html#PublicPreviewAPI()">PublicPreviewAPI</a>()</code></div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="list">
+ <h2>Public constructors</h2>
+ <div class="api-item"><a name="PublicPreviewAPI--"></a><a name="publicpreviewapi"></a>
+ <h3 class="api-name" id="PublicPreviewAPI()">PublicPreviewAPI</h3>
+ <pre class="api-signature no-pretty-print">public <a href="/docs/reference/android/com/google/firebase/vertexai/type/PublicPreviewAPI.html#PublicPreviewAPI()">PublicPreviewAPI</a>()</pre>
+ </div>
+ </div>
+ </body>
+</html>
+--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/package-summary.html 2025-02-04 19:45:10.343120276 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/package-summary.html 2025-02-04 19:43:02.030342865 +0000
@@ -6,6 +6,21 @@
</head>
<body>
<h1>com.google.firebase.vertexai.type</h1>
+ <h2>Annotations</h2>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/PublicPreviewAPI.html">PublicPreviewAPI</a></code></td>
+ <td></td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
<h2>Interfaces</h2>
<div class="devsite-table-wrapper">
<table class="responsive">--- /home/runner/diff/original/firebase-kotlindoc/kotlin/client/firebase-vertexai/_toc.yaml 2025-02-04 19:45:10.350120337 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/client/firebase-vertexai/_toc.yaml 2025-02-04 19:43:02.037342966 +0000
@@ -161,4 +161,10 @@
- title: "UnsupportedUserLocationException"
path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/UnsupportedUserLocationException.html"
+ - title: "Annotations"
+
+ section:
+ - title: "PublicPreviewAPI"
+ path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/PublicPreviewAPI.html"
+
--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/FirebaseVertexAI.html 2025-02-04 19:45:10.356120389 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/FirebaseVertexAI.html 2025-02-04 19:43:02.044343066 +0000
@@ -85,7 +85,7 @@
<tr>
<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>
+ <div><code>@<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/PublicPreviewAPI.html">PublicPreviewAPI</a><br><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>
@@ -220,7 +220,7 @@
</div>
<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>
+ <pre class="api-signature no-pretty-print">@<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/PublicPreviewAPI.html">PublicPreviewAPI</a><br>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">--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/ImagenModel.html 2025-02-04 19:45:10.355120381 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/ImagenModel.html 2025-02-04 19:43:02.043343052 +0000
@@ -8,7 +8,7 @@
<div id="metadata-info-block"></div>
<h1>ImagenModel</h1>
<p>
- <pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImagenModel.html">ImagenModel</a></pre>
+ <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/ImagenModel.html">ImagenModel</a></pre>
</p>
<hr>
<p>Represents a generative model (like Imagen), capable of generating images based on various input types.</p>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/java/ImagenModelFutures.html 2025-02-04 19:45:10.356120389 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/java/ImagenModelFutures.html 2025-02-04 19:43:02.044343066 +0000
@@ -8,7 +8,7 @@
<div id="metadata-info-block"></div>
<h1>ImagenModelFutures</h1>
<p>
- <pre>abstract class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/java/ImagenModelFutures.html">ImagenModelFutures</a></pre>
+ <pre>@<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/PublicPreviewAPI.html">PublicPreviewAPI</a><br>abstract class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/java/ImagenModelFutures.html">ImagenModelFutures</a></pre>
</p>
<hr>
<p>Wrapper class providing Java compatible methods for <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImagenModel.html">ImagenModel</a></code>.</p>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html 2025-02-04 19:45:10.351120346 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html 2025-02-04 19:43:02.038342980 +0000
@@ -8,7 +8,7 @@
<div id="metadata-info-block"></div>
<h1>ImagenAspectRatio</h1>
<p>
- <pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenAspectRatio.html">ImagenAspectRatio</a></pre>
+ <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/ImagenAspectRatio.html">ImagenAspectRatio</a></pre>
</p>
<hr>
<p>Represents the aspect ratio that the generated image should conform to.</p>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenGCSImage.html 2025-02-04 19:45:10.352120354 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenGCSImage.html 2025-02-04 19:43:02.040343009 +0000
@@ -8,7 +8,7 @@
<div id="metadata-info-block"></div>
<h1>ImagenGCSImage</h1>
<p>
- <pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGCSImage.html">ImagenGCSImage</a></pre>
+ <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/ImagenGCSImage.html">ImagenGCSImage</a></pre>
</p>
<hr>
<p>Represents an Imagen-generated image that is contained in Google Cloud Storage.</p>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html 2025-02-04 19:45:10.352120354 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html 2025-02-04 19:43:02.040343009 +0000
@@ -8,7 +8,7 @@
<div id="metadata-info-block"></div>
<h1>ImagenGenerationConfig</h1>
<p>
- <pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationConfig.html">ImagenGenerationConfig</a></pre>
+ <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>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenGenerationResponse.html 2025-02-04 19:45:10.350120337 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenGenerationResponse.html 2025-02-04 19:43:02.038342980 +0000
@@ -8,7 +8,7 @@
<div id="metadata-info-block"></div>
<h1>ImagenGenerationResponse</h1>
<p>
- <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>
+ <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/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>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenImageFormat.html 2025-02-04 19:45:10.354120372 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenImageFormat.html 2025-02-04 19:43:02.042343037 +0000
@@ -8,7 +8,7 @@
<div id="metadata-info-block"></div>
<h1>ImagenImageFormat</h1>
<p>
- <pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImageFormat.html">ImagenImageFormat</a></pre>
+ <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/ImagenImageFormat.html">ImagenImageFormat</a></pre>
</p>
<hr>
<p>Represents the format an image should be returned in.</p>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html 2025-02-04 19:45:10.354120372 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html 2025-02-04 19:43:02.042343037 +0000
@@ -8,7 +8,7 @@
<div id="metadata-info-block"></div>
<h1>ImagenInlineImage</h1>
<p>
- <pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html">ImagenInlineImage</a></pre>
+ <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/ImagenInlineImage.html">ImagenInlineImage</a></pre>
</p>
<hr>
<p>Represents an Imagen-generated image that is contained inline</p>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.html 2025-02-04 19:45:10.354120372 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.html 2025-02-04 19:43:02.042343037 +0000
@@ -8,7 +8,7 @@
<div id="metadata-info-block"></div>
<h1>ImagenPersonFilterLevel</h1>
<p>
- <pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.html">ImagenPersonFilterLevel</a></pre>
+ <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/ImagenPersonFilterLevel.html">ImagenPersonFilterLevel</a></pre>
</p>
<hr>
<p>A filter used to prevent images from containing depictions of children or people.</p>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.html 2025-02-04 19:45:10.353120363 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.html 2025-02-04 19:43:02.041343023 +0000
@@ -8,7 +8,7 @@
<div id="metadata-info-block"></div>
<h1>ImagenSafetyFilterLevel</h1>
<p>
- <pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a></pre>
+ <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/ImagenSafetyFilterLevel.html">ImagenSafetyFilterLevel</a></pre>
</p>
<hr>
<p>Used for safety filtering.</p>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenSafetySettings.html 2025-02-04 19:45:10.351120346 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenSafetySettings.html 2025-02-04 19:43:02.039342994 +0000
@@ -8,7 +8,7 @@
<div id="metadata-info-block"></div>
<h1>ImagenSafetySettings</h1>
<p>
- <pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenSafetySettings.html">ImagenSafetySettings</a></pre>
+ <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/ImagenSafetySettings.html">ImagenSafetySettings</a></pre>
</p>
<hr>
<p>A configuration for filtering unsafe content or images containing people.</p>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/PublicPreviewAPI.html 1970-01-01 00:00:00.000000000 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/PublicPreviewAPI.html 2025-02-04 19:43:02.043343052 +0000
@@ -0,0 +1,44 @@
+<html devsite="true">
+ <head>
+ <title>PublicPreviewAPI</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/kotlin/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>PublicPreviewAPI</h1>
+ <p>
+ <pre>@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-retention/index.html">Retention</a>(value = AnnotationRetention.BINARY)<br>@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-requires-opt-in/index.html">RequiresOptIn</a>(level = RequiresOptIn.Level.ERROR, message = "This API is currently experimental and in public preview and may change in behavior in backwards-incompatible ways without notice.")<br>annotation <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/PublicPreviewAPI.html">PublicPreviewAPI</a></pre>
+ </p>
+ <hr>
+ <h2>Summary</h2>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Public constructors</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/PublicPreviewAPI.html#PublicPreviewAPI()">PublicPreviewAPI</a>()</code></div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="list">
+ <h2>Public constructors</h2>
+ <div class="api-item"><a name="PublicPreviewAPI--"></a><a name="publicpreviewapi"></a>
+ <h3 class="api-name" id="PublicPreviewAPI()">PublicPreviewAPI</h3>
+ <pre class="api-signature no-pretty-print"><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/PublicPreviewAPI.html#PublicPreviewAPI()">PublicPreviewAPI</a>()</pre>
+ </div>
+ </div>
+ </body>
+</html>
+--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/package-summary.html 2025-02-04 19:45:10.351120346 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/package-summary.html 2025-02-04 19:43:02.039342994 +0000
@@ -381,6 +381,21 @@
</tbody>
</table>
</div>
+ <h2>Annotations</h2>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/PublicPreviewAPI.html">PublicPreviewAPI</a></code></td>
+ <td></td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
<h2>Top-level functions summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -406,7 +421,7 @@
<tr>
<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>
+ <div><code>@<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/PublicPreviewAPI.html">PublicPreviewAPI</a><br><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>
@@ -470,7 +485,7 @@
</div>
<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>
+ <pre class="api-signature no-pretty-print">@<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/PublicPreviewAPI.html">PublicPreviewAPI</a><br>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> |
rlazo
approved these changes
Feb 4, 2025
daymxn
approved these changes
Feb 4, 2025
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/PublicPreviewAPI.kt
Outdated
Show resolved
Hide resolved
…/type/PublicPreviewAPI.kt Co-authored-by: Daymon <[email protected]>
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.