Davidmotson.imagen java #6618
Merged
Davidmotson.imagen java #6618
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
Javadoc Changes:--- /home/runner/diff/original/firebase-kotlindoc/android/client/firebase-vertexai/_toc.yaml 2025-01-28 21:52:18.953116356 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/client/firebase-vertexai/_toc.yaml 2025-01-28 21:50:12.731035011 +0000
@@ -28,6 +28,8 @@
path: "/docs/reference/android/com/google/firebase/vertexai/java/ChatFutures.html"
- title: "GenerativeModelFutures"
path: "/docs/reference/android/com/google/firebase/vertexai/java/GenerativeModelFutures.html"
+ - title: "ImagenModelFutures"
+ path: "/docs/reference/android/com/google/firebase/vertexai/java/ImagenModelFutures.html"
- title: "com.google.firebase.vertexai.type"
path: "/docs/reference/android/com/google/firebase/vertexai/type/package-summary.html"
@@ -104,8 +106,6 @@
path: "/docs/reference/android/com/google/firebase/vertexai/type/ImagenImageFormat.html"
- title: "ImagenInlineImage"
path: "/docs/reference/android/com/google/firebase/vertexai/type/ImagenInlineImage.html"
- - title: "ImagenModelConfig"
- path: "/docs/reference/android/com/google/firebase/vertexai/type/ImagenModelConfig.html"
- title: "ImagenPersonFilterLevel"
path: "/docs/reference/android/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.html"
- title: "ImagenSafetyFilterLevel"--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/java/ImagenModelFutures.Companion.html 1970-01-01 00:00:00.000000000 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/java/ImagenModelFutures.Companion.html 2025-01-28 21:50:12.740034956 +0000
@@ -0,0 +1,66 @@
+<html devsite="true">
+ <head>
+ <title>ImagenModelFutures.Companion</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/android/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>ImagenModelFutures.Companion</h1>
+ <p>
+ <pre>public static class <a href="/docs/reference/android/com/google/firebase/vertexai/java/ImagenModelFutures.Companion.html">ImagenModelFutures.Companion</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 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/java/ImagenModelFutures.html">ImagenModelFutures</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/java/ImagenModelFutures.Companion.html#from(com.google.firebase.vertexai.ImagenModel)">from</a>(@<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> model)</code></div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="list">
+ <h2>Public methods</h2>
+ <div class="api-item"><a name="from-com.google.firebase.vertexai.ImagenModel-"></a><a name="from"></a>
+ <h3 class="api-name" id="from(com.google.firebase.vertexai.ImagenModel)">from</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/java/ImagenModelFutures.html">ImagenModelFutures</a> <a href="/docs/reference/android/com/google/firebase/vertexai/java/ImagenModelFutures.Companion.html#from(com.google.firebase.vertexai.ImagenModel)">from</a>(@<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> model)</pre>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Returns</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/java/ImagenModelFutures.html">ImagenModelFutures</a></code></td>
+ <td>
+ <p>a <code><a href="/docs/reference/android/com/google/firebase/vertexai/java/ImagenModelFutures.html">ImagenModelFutures</a></code> created around the provided <code><a href="/docs/reference/android/com/google/firebase/vertexai/ImagenModel.html">ImagenModel</a></code></p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ </div>
+ </body>
+</html>
+--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/java/ImagenModelFutures.html 1970-01-01 00:00:00.000000000 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/java/ImagenModelFutures.html 2025-01-28 21:50:12.740034956 +0000
@@ -0,0 +1,190 @@
+<html devsite="true">
+ <head>
+ <title>ImagenModelFutures</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/android/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <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>
+ </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>
+ <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/ImagenModel.html">ImagenModel</a></code></td>
+ <td></td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <h2>Summary</h2>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Nested types</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td>
+ <div><code>public static class <a href="/docs/reference/android/com/google/firebase/vertexai/java/ImagenModelFutures.Companion.html">ImagenModelFutures.Companion</a></code></div>
+ </td>
+ </tr>
+ </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/java/ImagenModelFutures.html">ImagenModelFutures</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/java/ImagenModelFutures.Companion.html#from(com.google.firebase.vertexai.ImagenModel)">from</a>(@<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> model)</code></div>
+ </td>
+ </tr>
+ <tr>
+ <td><code>abstract @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/common/util/concurrent/ListenableFuture.html">ListenableFuture</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/ImagenGenerationResponse.html">ImagenGenerationResponse</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenInlineImage.html">ImagenInlineImage</a>>></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/java/ImagenModelFutures.html#generateImages(kotlin.String)">generateImages</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> prompt)</code></div>
+ <p>Generates an image, returning the result directly to the caller.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>abstract @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/common/util/concurrent/ListenableFuture.html">ListenableFuture</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/ImagenGenerationResponse.html">ImagenGenerationResponse</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGCSImage.html">ImagenGCSImage</a>>></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/vertexai/java/ImagenModelFutures.html#generateImages(kotlin.String,kotlin.String)">generateImages</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> prompt, @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> gcsUri)</code></div>
+ <p>Generates an image, storing the result in Google Cloud Storage and returning a URL</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>abstract @<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/java/ImagenModelFutures.html#getImageModel()">getImageModel</a>()</code></div>
+ <p>Returns the <code><a href="/docs/reference/android/com/google/firebase/vertexai/ImagenModel.html">ImagenModel</a></code> object wrapped by this object.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="list">
+ <h2>Public methods</h2>
+ <div class="api-item"><a name="from-com.google.firebase.vertexai.ImagenModel-"></a><a name="from"></a>
+ <h3 class="api-name" id="from(com.google.firebase.vertexai.ImagenModel)">from</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/java/ImagenModelFutures.html">ImagenModelFutures</a> <a href="/docs/reference/android/com/google/firebase/vertexai/java/ImagenModelFutures.Companion.html#from(com.google.firebase.vertexai.ImagenModel)">from</a>(@<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> model)</pre>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Returns</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/java/ImagenModelFutures.html">ImagenModelFutures</a></code></td>
+ <td>
+ <p>a <code><a href="/docs/reference/android/com/google/firebase/vertexai/java/ImagenModelFutures.html">ImagenModelFutures</a></code> created around the provided <code><a href="/docs/reference/android/com/google/firebase/vertexai/ImagenModel.html">ImagenModel</a></code></p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="generateImages-kotlin.String-"></a><a name="generateimages"></a>
+ <h3 class="api-name" id="generateImages(kotlin.String)">generateImages</h3>
+ <pre class="api-signature no-pretty-print">public abstract @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/common/util/concurrent/ListenableFuture.html">ListenableFuture</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/ImagenGenerationResponse.html">ImagenGenerationResponse</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenInlineImage.html">ImagenInlineImage</a>>> <a href="/docs/reference/android/com/google/firebase/vertexai/java/ImagenModelFutures.html#generateImages(kotlin.String)">generateImages</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> prompt)</pre>
+ <p>Generates an image, returning the result directly to the caller.</p>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Parameters</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> prompt</code></td>
+ <td>
+ <p>The main text prompt from which the image is generated.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="generateImages(kotlin.String, kotlin.String)"></a><a name="generateImages-kotlin.String-kotlin.String-"></a><a name="generateimages"></a>
+ <h3 class="api-name" id="generateImages(kotlin.String,kotlin.String)">generateImages</h3>
+ <pre class="api-signature no-pretty-print">public abstract @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/common/util/concurrent/ListenableFuture.html">ListenableFuture</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/ImagenGenerationResponse.html">ImagenGenerationResponse</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenGCSImage.html">ImagenGCSImage</a>>> <a href="/docs/reference/android/com/google/firebase/vertexai/java/ImagenModelFutures.html#generateImages(kotlin.String,kotlin.String)">generateImages</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> prompt, @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> gcsUri)</pre>
+ <p>Generates an image, storing the result in Google Cloud Storage and returning a URL</p>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Parameters</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> prompt</code></td>
+ <td>
+ <p>The main text prompt from which the image is generated.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> gcsUri</code></td>
+ <td>
+ <p>Specifies the GCS bucket in which to store the image.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="getImageModel--"></a><a name="getimagemodel"></a>
+ <h3 class="api-name" id="getImageModel()">getImageModel</h3>
+ <pre class="api-signature no-pretty-print">public abstract @<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/java/ImagenModelFutures.html#getImageModel()">getImageModel</a>()</pre>
+ <p>Returns the <code><a href="/docs/reference/android/com/google/firebase/vertexai/ImagenModel.html">ImagenModel</a></code> object wrapped by this object.</p>
+ </div>
+ </div>
+ </body>
+</html>
+--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/java/package-summary.html 2025-01-28 21:52:18.961116304 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/java/package-summary.html 2025-01-28 21:50:12.739034962 +0000
@@ -26,6 +26,12 @@
<p>Wrapper class providing Java compatible methods for <code><a href="/docs/reference/android/com/google/firebase/vertexai/GenerativeModel.html">GenerativeModel</a></code>.</p>
</td>
</tr>
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/java/ImagenModelFutures.html">ImagenModelFutures</a></code></td>
+ <td>
+ <p>Wrapper class providing Java compatible methods for <code><a href="/docs/reference/android/com/google/firebase/vertexai/ImagenModel.html">ImagenModel</a></code>.</p>
+ </td>
+ </tr>
</tbody>
</table>
</div>--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenModelConfig.html 2025-01-28 21:52:18.954116350 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/ImagenModelConfig.html 1970-01-01 00:00:00.000000000 +0000
@@ -1,16 +0,0 @@
-<html devsite="true">
- <head>
- <title>ImagenModelConfig</title>
-{% setvar book_path %}/_book.yaml{% endsetvar %}
-{% include "docs/reference/android/_reference-head-tags.html" %}
- </head>
- <body>
- <div id="metadata-info-block"></div>
- <h1>ImagenModelConfig</h1>
- <p>
- <pre>public final class <a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenModelConfig.html">ImagenModelConfig</a></pre>
- </p>
- <hr>
- </body>
-</html>
---- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/package-summary.html 2025-01-28 21:52:18.955116343 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/package-summary.html 2025-01-28 21:50:12.733034999 +0000
@@ -200,10 +200,6 @@
<td></td>
</tr>
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenModelConfig.html">ImagenModelConfig</a></code></td>
- <td></td>
- </tr>
- <tr>
<td><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.html">ImagenPersonFilterLevel</a></code></td>
<td></td>
</tr>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/client/firebase-vertexai/_toc.yaml 2025-01-28 21:52:18.961116304 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/client/firebase-vertexai/_toc.yaml 2025-01-28 21:50:12.740034956 +0000
@@ -26,6 +26,8 @@
path: "/docs/reference/kotlin/com/google/firebase/vertexai/java/ChatFutures.html"
- title: "GenerativeModelFutures"
path: "/docs/reference/kotlin/com/google/firebase/vertexai/java/GenerativeModelFutures.html"
+ - title: "ImagenModelFutures"
+ path: "/docs/reference/kotlin/com/google/firebase/vertexai/java/ImagenModelFutures.html"
- title: "com.google.firebase.vertexai.type"
path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/package-summary.html"
@@ -98,8 +100,6 @@
path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenImageFormat.html"
- title: "ImagenInlineImage"
path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html"
- - title: "ImagenModelConfig"
- path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenModelConfig.html"
- title: "ImagenPersonFilterLevel"
path: "/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.html"
- title: "ImagenSafetyFilterLevel"--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/java/ImagenModelFutures.html 1970-01-01 00:00:00.000000000 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/java/ImagenModelFutures.html 2025-01-28 21:50:12.747034913 +0000
@@ -0,0 +1,188 @@
+<html devsite="true">
+ <head>
+ <title>ImagenModelFutures</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/kotlin/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <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>
+ </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>
+ <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/ImagenModel.html">ImagenModel</a></code></td>
+ <td></td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <h2>Summary</h2>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Public companion functions</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/java/ImagenModelFutures.html">ImagenModelFutures</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/java/ImagenModelFutures.Companion.html#from(com.google.firebase.vertexai.ImagenModel)">from</a>(model: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImagenModel.html">ImagenModel</a>)</code></div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Public functions</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>abstract <a href="/docs/reference/kotlin/com/google/common/util/concurrent/ListenableFuture.html">ListenableFuture</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationResponse.html">ImagenGenerationResponse</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html">ImagenInlineImage</a>>></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/java/ImagenModelFutures.html#generateImages(kotlin.String)">generateImages</a>(prompt: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
+ <p>Generates an image, returning the result directly to the caller.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>abstract <a href="/docs/reference/kotlin/com/google/common/util/concurrent/ListenableFuture.html">ListenableFuture</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationResponse.html">ImagenGenerationResponse</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGCSImage.html">ImagenGCSImage</a>>></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/java/ImagenModelFutures.html#generateImages(kotlin.String,kotlin.String)">generateImages</a>(prompt: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, gcsUri: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
+ <p>Generates an image, storing the result in Google Cloud Storage and returning a URL</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>abstract <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/java/ImagenModelFutures.html#getImageModel()">getImageModel</a>()</code></div>
+ <p>Returns the <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImagenModel.html">ImagenModel</a></code> object wrapped by this object.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="list">
+ <h2>Public companion functions</h2>
+ <div class="api-item"><a name="from-com.google.firebase.vertexai.ImagenModel-"></a><a name="from"></a>
+ <h3 class="api-name" id="from(com.google.firebase.vertexai.ImagenModel)">from</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/java/ImagenModelFutures.Companion.html#from(com.google.firebase.vertexai.ImagenModel)">from</a>(model: <a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImagenModel.html">ImagenModel</a>): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/java/ImagenModelFutures.html">ImagenModelFutures</a></pre>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Returns</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/java/ImagenModelFutures.html">ImagenModelFutures</a></code></td>
+ <td>
+ <p>a <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/java/ImagenModelFutures.html">ImagenModelFutures</a></code> created around the provided <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImagenModel.html">ImagenModel</a></code></p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ </div>
+ <div class="list">
+ <h2>Public functions</h2>
+ <div class="api-item"><a name="generateImages-kotlin.String-"></a><a name="generateimages"></a>
+ <h3 class="api-name" id="generateImages(kotlin.String)">generateImages</h3>
+ <pre class="api-signature no-pretty-print">abstract fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/java/ImagenModelFutures.html#generateImages(kotlin.String)">generateImages</a>(prompt: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>): <a href="/docs/reference/kotlin/com/google/common/util/concurrent/ListenableFuture.html">ListenableFuture</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationResponse.html">ImagenGenerationResponse</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenInlineImage.html">ImagenInlineImage</a>>></pre>
+ <p>Generates an image, returning the result directly to the caller.</p>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Parameters</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>prompt: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
+ <td>
+ <p>The main text prompt from which the image is generated.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="generateImages(kotlin.String, kotlin.String)"></a><a name="generateImages-kotlin.String-kotlin.String-"></a><a name="generateimages"></a>
+ <h3 class="api-name" id="generateImages(kotlin.String,kotlin.String)">generateImages</h3>
+ <pre class="api-signature no-pretty-print">abstract fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/java/ImagenModelFutures.html#generateImages(kotlin.String,kotlin.String)">generateImages</a>(prompt: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>, gcsUri: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>): <a href="/docs/reference/kotlin/com/google/common/util/concurrent/ListenableFuture.html">ListenableFuture</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGenerationResponse.html">ImagenGenerationResponse</a><<a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenGCSImage.html">ImagenGCSImage</a>>></pre>
+ <p>Generates an image, storing the result in Google Cloud Storage and returning a URL</p>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Parameters</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>prompt: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
+ <td>
+ <p>The main text prompt from which the image is generated.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>gcsUri: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
+ <td>
+ <p>Specifies the GCS bucket in which to store the image.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="getImageModel--"></a><a name="getimagemodel"></a>
+ <h3 class="api-name" id="getImageModel()">getImageModel</h3>
+ <pre class="api-signature no-pretty-print">abstract fun <a href="/docs/reference/kotlin/com/google/firebase/vertexai/java/ImagenModelFutures.html#getImageModel()">getImageModel</a>(): <a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImagenModel.html">ImagenModel</a></pre>
+ <p>Returns the <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImagenModel.html">ImagenModel</a></code> object wrapped by this object.</p>
+ </div>
+ </div>
+ </body>
+</html>
+--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/java/package-summary.html 2025-01-28 21:52:18.967116264 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/java/package-summary.html 2025-01-28 21:50:12.747034913 +0000
@@ -26,6 +26,12 @@
<p>Wrapper class providing Java compatible methods for <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/GenerativeModel.html">GenerativeModel</a></code>.</p>
</td>
</tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/java/ImagenModelFutures.html">ImagenModelFutures</a></code></td>
+ <td>
+ <p>Wrapper class providing Java compatible methods for <code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/ImagenModel.html">ImagenModel</a></code>.</p>
+ </td>
+ </tr>
</tbody>
</table>
</div>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenModelConfig.html 2025-01-28 21:52:18.963116291 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/ImagenModelConfig.html 1970-01-01 00:00:00.000000000 +0000
@@ -1,16 +0,0 @@
-<html devsite="true">
- <head>
- <title>ImagenModelConfig</title>
-{% setvar book_path %}/_book.yaml{% endsetvar %}
-{% include "docs/reference/kotlin/_reference-head-tags.html" %}
- </head>
- <body>
- <div id="metadata-info-block"></div>
- <h1>ImagenModelConfig</h1>
- <p>
- <pre>class <a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenModelConfig.html">ImagenModelConfig</a></pre>
- </p>
- <hr>
- </body>
-</html>
---- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/package-summary.html 2025-01-28 21:52:18.963116291 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/vertexai/type/package-summary.html 2025-01-28 21:50:12.742034944 +0000
@@ -192,10 +192,6 @@
<td></td>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenModelConfig.html">ImagenModelConfig</a></code></td>
- <td></td>
- </tr>
- <tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/vertexai/type/ImagenPersonFilterLevel.html">ImagenPersonFilterLevel</a></code></td>
<td></td>
</tr> |
Generated by 🚫 Danger |
emilypgoogle
approved these changes
Jan 13, 2025
davidmotson
merged commit b06df72
into
davidmotson.imagen_support
23 of 25 checks passed
davidmotson
added a commit
that referenced
this pull request
Jan 30, 2025
Co-authored-by: David Motsonashvili <davidmotson@google.com>
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.