|
1 | 1 | <!DOCTYPE HTML> |
2 | 2 | <html lang="en"> |
3 | 3 | <head> |
4 | | -<!-- Generated by javadoc (17) on Thu Jun 12 21:38:50 UTC 2025 --> |
| 4 | +<!-- Generated by javadoc (17) on Thu Jun 12 21:46:38 UTC 2025 --> |
5 | 5 | <title>AsyncModels (google-genai 1.5.0-SNAPSHOT API)</title> |
6 | 6 | <meta name="viewport" content="width=device-width, initial-scale=1"> |
7 | 7 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
@@ -214,37 +214,45 @@ <h2>Method Summary</h2> |
214 | 214 | <div class="block">Asynchronously generates images given a GenAI model and a prompt.</div> |
215 | 215 | </div> |
216 | 216 | <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a><<a href="types/GenerateVideosOperation.html" title="class in com.google.genai.types">GenerateVideosOperation</a>></code></div> |
217 | | -<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#generateVideos(java.lang.String,java.lang.String,com.google.genai.types.Image,com.google.genai.types.Video,com.google.genai.types.GenerateVideosConfig)" class="member-name-link">generateVideos</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> model, |
| 217 | +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#generateVideos(java.lang.String,java.lang.String,com.google.genai.types.Image,com.google.genai.types.GenerateVideosConfig)" class="member-name-link">generateVideos</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> model, |
218 | 218 | <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> prompt, |
219 | 219 | <a href="types/Image.html" title="class in com.google.genai.types">Image</a> image, |
220 | | - <a href="types/Video.html" title="class in com.google.genai.types">Video</a> video, |
221 | 220 | <a href="types/GenerateVideosConfig.html" title="class in com.google.genai.types">GenerateVideosConfig</a> config)</code></div> |
222 | 221 | <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| 222 | +<div class="block">Asynchronously generates videos given a GenAI model, and an input (text, image).</div> |
| 223 | +</div> |
| 224 | +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a><<a href="types/GenerateVideosOperation.html" title="class in com.google.genai.types">GenerateVideosOperation</a>></code></div> |
| 225 | +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#generateVideos(java.lang.String,java.lang.String,com.google.genai.types.Image,com.google.genai.types.Video,com.google.genai.types.GenerateVideosConfig)" class="member-name-link">generateVideos</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> model, |
| 226 | + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> prompt, |
| 227 | + <a href="types/Image.html" title="class in com.google.genai.types">Image</a> image, |
| 228 | + <a href="types/Video.html" title="class in com.google.genai.types">Video</a> video, |
| 229 | + <a href="types/GenerateVideosConfig.html" title="class in com.google.genai.types">GenerateVideosConfig</a> config)</code></div> |
| 230 | +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
223 | 231 | <div class="block">Asynchronously generates videos given a GenAI model, and an input (text, image, or video).</div> |
224 | 232 | </div> |
225 | | -<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a><<a href="types/Model.html" title="class in com.google.genai.types">Model</a>></code></div> |
226 | | -<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#get(java.lang.String,com.google.genai.types.GetModelConfig)" class="member-name-link">get</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> model, |
| 233 | +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a><<a href="types/Model.html" title="class in com.google.genai.types">Model</a>></code></div> |
| 234 | +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#get(java.lang.String,com.google.genai.types.GetModelConfig)" class="member-name-link">get</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> model, |
227 | 235 | <a href="types/GetModelConfig.html" title="class in com.google.genai.types">GetModelConfig</a> config)</code></div> |
228 | | -<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| 236 | +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
229 | 237 | <div class="block">Asynchronously fetches information about a model by name.</div> |
230 | 238 | </div> |
231 | | -<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a><<a href="AsyncPager.html" title="class in com.google.genai">AsyncPager</a><<a href="types/Model.html" title="class in com.google.genai.types">Model</a>>></code></div> |
232 | | -<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#list(com.google.genai.types.ListModelsConfig)" class="member-name-link">list</a><wbr>(<a href="types/ListModelsConfig.html" title="class in com.google.genai.types">ListModelsConfig</a> config)</code></div> |
233 | | -<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| 239 | +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a><<a href="AsyncPager.html" title="class in com.google.genai">AsyncPager</a><<a href="types/Model.html" title="class in com.google.genai.types">Model</a>>></code></div> |
| 240 | +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#list(com.google.genai.types.ListModelsConfig)" class="member-name-link">list</a><wbr>(<a href="types/ListModelsConfig.html" title="class in com.google.genai.types">ListModelsConfig</a> config)</code></div> |
| 241 | +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
234 | 242 | <div class="block">Asynchronously makes an API request to list the available models.</div> |
235 | 243 | </div> |
236 | | -<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a><<a href="types/Model.html" title="class in com.google.genai.types">Model</a>></code></div> |
237 | | -<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(java.lang.String,com.google.genai.types.UpdateModelConfig)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> model, |
| 244 | +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a><<a href="types/Model.html" title="class in com.google.genai.types">Model</a>></code></div> |
| 245 | +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(java.lang.String,com.google.genai.types.UpdateModelConfig)" class="member-name-link">update</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> model, |
238 | 246 | <a href="types/UpdateModelConfig.html" title="class in com.google.genai.types">UpdateModelConfig</a> config)</code></div> |
239 | | -<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| 247 | +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
240 | 248 | <div class="block">Asynchronously updates a tuned model by its name.</div> |
241 | 249 | </div> |
242 | | -<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a><<a href="types/UpscaleImageResponse.html" title="class in com.google.genai.types">UpscaleImageResponse</a>></code></div> |
243 | | -<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#upscaleImage(java.lang.String,com.google.genai.types.Image,java.lang.String,com.google.genai.types.UpscaleImageConfig)" class="member-name-link">upscaleImage</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> model, |
| 250 | +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a><<a href="types/UpscaleImageResponse.html" title="class in com.google.genai.types">UpscaleImageResponse</a>></code></div> |
| 251 | +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#upscaleImage(java.lang.String,com.google.genai.types.Image,java.lang.String,com.google.genai.types.UpscaleImageConfig)" class="member-name-link">upscaleImage</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> model, |
244 | 252 | <a href="types/Image.html" title="class in com.google.genai.types">Image</a> image, |
245 | 253 | <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> upscaleFactor, |
246 | 254 | <a href="types/UpscaleImageConfig.html" title="class in com.google.genai.types">UpscaleImageConfig</a> config)</code></div> |
247 | | -<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| 255 | +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
248 | 256 | <div class="block">Asynchronously upscales an image given a GenAI model and an image and an upscale factor.</div> |
249 | 257 | </div> |
250 | 258 | </div> |
@@ -591,6 +599,29 @@ <h3>upscaleImage</h3> |
591 | 599 | </section> |
592 | 600 | </li> |
593 | 601 | <li> |
| 602 | +<section class="detail" id="generateVideos(java.lang.String,java.lang.String,com.google.genai.types.Image,com.google.genai.types.GenerateVideosConfig)"> |
| 603 | +<h3>generateVideos</h3> |
| 604 | +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a><<a href="types/GenerateVideosOperation.html" title="class in com.google.genai.types">GenerateVideosOperation</a>></span> <span class="element-name">generateVideos</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> model, |
| 605 | + <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> prompt, |
| 606 | + <a href="types/Image.html" title="class in com.google.genai.types">Image</a> image, |
| 607 | + <a href="types/GenerateVideosConfig.html" title="class in com.google.genai.types">GenerateVideosConfig</a> config)</span></div> |
| 608 | +<div class="block">Asynchronously generates videos given a GenAI model, and an input (text, image). |
| 609 | + |
| 610 | + <p>This method is experimental, and kept for backward compatibility.</div> |
| 611 | +<dl class="notes"> |
| 612 | +<dt>Parameters:</dt> |
| 613 | +<dd><code>model</code> - the name of the GenAI model to use for generating videos</dd> |
| 614 | +<dd><code>prompt</code> - the text prompt for generating the videos. Optional for image to video use cases.</dd> |
| 615 | +<dd><code>image</code> - the input image for generating the videos. Optional if prompt is provided.</dd> |
| 616 | +<dd><code>config</code> - a <a href="types/GenerateVideosConfig.html" title="class in com.google.genai.types"><code>GenerateVideosConfig</code></a> instance that specifies the |
| 617 | + optional configurations</dd> |
| 618 | +<dt>Returns:</dt> |
| 619 | +<dd>a <a href="types/GenerateVideosOperation.html" title="class in com.google.genai.types"><code>GenerateVideosOperation</code></a> instance that contains the |
| 620 | + generated videos.</dd> |
| 621 | +</dl> |
| 622 | +</section> |
| 623 | +</li> |
| 624 | +<li> |
594 | 625 | <section class="detail" id="embedContent(java.lang.String,java.lang.String,com.google.genai.types.EmbedContentConfig)"> |
595 | 626 | <h3>embedContent</h3> |
596 | 627 | <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html" title="class or interface in java.util.concurrent" class="external-link">CompletableFuture</a><<a href="types/EmbedContentResponse.html" title="class in com.google.genai.types">EmbedContentResponse</a>></span> <span class="element-name">embedContent</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> model, |
|
0 commit comments