Package com.google.genai

Class AsyncModels

java.lang.Object

com.google.genai.AsyncModels

public final class AsyncModels
extends Object

Async module of Models

Constructor Summary

Constructors

Constructor	Description
AsyncModels(com.google.genai.ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<ComputeTokensResponse>	computeTokens(String model, String text, ComputeTokensConfig config)	Asynchronously computes tokens given a GenAI model and a text string.
CompletableFuture<ComputeTokensResponse>	computeTokens(String model, List<Content> contents, ComputeTokensConfig config)	Asynchronously computes tokens given a GenAI model and a list of content.
CompletableFuture<CountTokensResponse>	countTokens(String model, String text, CountTokensConfig config)	Asynchronously counts tokens given a GenAI model and a text string.
CompletableFuture<CountTokensResponse>	countTokens(String model, List<Content> contents, CountTokensConfig config)	Asynchronously counts tokens given a GenAI model and a list of content.
CompletableFuture<DeleteModelResponse>	delete(String model, DeleteModelConfig config)	Asynchronously fetches information about a model by name.
CompletableFuture<EditImageResponse>	editImage(String model, String prompt, List<ReferenceImage> referenceImages, EditImageConfig config)	Asynchronously edits an image given a GenAI model, a prompt, and a list of reference images.
CompletableFuture<EmbedContentResponse>	embedContent(String model, String text, EmbedContentConfig config)	Asynchronously embeds content given a GenAI model and a text string.
CompletableFuture<EmbedContentResponse>	embedContent(String model, List<String> texts, EmbedContentConfig config)	Asynchronously embeds content given a GenAI model and a list of text strings.
CompletableFuture<GenerateContentResponse>	generateContent(String model, Content content, GenerateContentConfig config)	Asynchronously generates content given a GenAI model and a content object.
CompletableFuture<GenerateContentResponse>	generateContent(String model, String text, GenerateContentConfig config)	Asynchronously generates content given a GenAI model and a text string.
CompletableFuture<GenerateContentResponse>	generateContent(String model, List<Content> contents, GenerateContentConfig config)	Asynchronously generates content given a GenAI model and a list of content.
CompletableFuture<ResponseStream<GenerateContentResponse>>	generateContentStream(String model, Content content, GenerateContentConfig config)	Asynchronously generates content with streaming support given a GenAI model and a content object.
CompletableFuture<ResponseStream<GenerateContentResponse>>	generateContentStream(String model, String text, GenerateContentConfig config)	Asynchronously generates content with streaming support given a GenAI model and a text string.
CompletableFuture<ResponseStream<GenerateContentResponse>>	generateContentStream(String model, List<Content> contents, GenerateContentConfig config)	Asynchronously generates content with streaming support given a GenAI model and a list of content.
CompletableFuture<GenerateImagesResponse>	generateImages(String model, String prompt, GenerateImagesConfig config)	Asynchronously generates images given a GenAI model and a prompt.
CompletableFuture<GenerateVideosOperation>	generateVideos(String model, GenerateVideosSource source, GenerateVideosConfig config)	Asynchronously generates videos given a GenAI model, and a GenerateVideosSource source.
CompletableFuture<GenerateVideosOperation>	generateVideos(String model, String prompt, Image image, GenerateVideosConfig config)	Asynchronously generates videos given a GenAI model, and an input (text, image).
CompletableFuture<GenerateVideosOperation>	generateVideos(String model, String prompt, Image image, Video video, GenerateVideosConfig config)	Asynchronously generates videos given a GenAI model, and an input (text, image, or video).
CompletableFuture<Model>	get(String model, GetModelConfig config)	Asynchronously fetches information about a model by name.
CompletableFuture<AsyncPager<Model>>	list(ListModelsConfig config)	Asynchronously makes an API request to list the available models.
CompletableFuture<RecontextImageResponse>	recontextImage(String model, RecontextImageSource source, RecontextImageConfig config)	Asynchronously recontextualizes an image.
CompletableFuture<SegmentImageResponse>	segmentImage(String model, SegmentImageSource source, SegmentImageConfig config)	Asynchronously segments an image, creating a mask of a specified area.
CompletableFuture<Model>	update(String model, UpdateModelConfig config)	Asynchronously updates a tuned model by its name.
CompletableFuture<UpscaleImageResponse>	upscaleImage(String model, Image image, String upscaleFactor, UpscaleImageConfig config)	Asynchronously upscales an image given a GenAI model and an image and an upscale factor.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AsyncModels

public AsyncModels(com.google.genai.ApiClient apiClient)

Method Details

recontextImage

public CompletableFuture<RecontextImageResponse> recontextImage(String model,
 RecontextImageSource source,
 RecontextImageConfig config)

Asynchronously recontextualizes an image.

There are two types of recontextualization currently supported: 1) Imagen Product Recontext - Generate images of products in new scenes and contexts. 2) Virtual Try-On: Generate images of persons modeling fashion products.

Parameters:

model - the name of the GenAI model to use for image recontext

source - a RecontextImageSource An object containing the source inputs (prompt, personImage, productImages) for image recontext. prompt is optional for product recontext and disallowed for virtual try-on. personImage is required for virtual try-on, disallowed for product recontext. productImages is required for both product recontext and virtual try-on. Only one product image is supported for virtual try-on, and up to 3 product images (different angles of the same product) are supported for product recontext.

config - a RecontextImageConfig instance that specifies the optional configurations

Returns:

a RecontextImageResponse instance that contains the generated images.

segmentImage

public CompletableFuture<SegmentImageResponse> segmentImage(String model,
 SegmentImageSource source,
 SegmentImageConfig config)

Asynchronously segments an image, creating a mask of a specified area.

Parameters:

model - the name of the GenAI model to use for image segmentation

source - a SegmentImageSource An object containing the source inputs (prompt, image, scribbleImmage) for image segmentation. The prompt is required for prompt mode and semantic mode, disallowed for other modes. scribbleImage is required for the interactive mode, disallowed for other modes.

config - a SegmentImageConfig instance that specifies the optional configurations

Returns:

a SegmentImageResponse instance that contains the generated mask.

get

public CompletableFuture<Model> get(String model,
 GetModelConfig config)

Asynchronously fetches information about a model by name.

update

public CompletableFuture<Model> update(String model,
 UpdateModelConfig config)

Asynchronously updates a tuned model by its name.

Parameters:

model - The name of the tuned model to update

config - A UpdateModelConfig instance that specifies the optional configurations

Returns:

A Model instance

delete

public CompletableFuture<DeleteModelResponse> delete(String model,
 DeleteModelConfig config)

Asynchronously fetches information about a model by name.

countTokens

public CompletableFuture<CountTokensResponse> countTokens(String model,
 List<Content> contents,
 CountTokensConfig config)

Asynchronously counts tokens given a GenAI model and a list of content.

Parameters:

model - the name of the GenAI model to use.

contents - a List<Content> to send to count tokens for.

config - a CountTokensConfig instance that specifies the optional configurations

Returns:

a CountTokensResponse instance that contains tokens count.

computeTokens

public CompletableFuture<ComputeTokensResponse> computeTokens(String model,
 List<Content> contents,
 ComputeTokensConfig config)

Asynchronously computes tokens given a GenAI model and a list of content.

Parameters:

model - the name of the GenAI model to use.

contents - a List<Content> to send to compute tokens for.

config - a ComputeTokensConfig instance that specifies the optional configurations

Returns:

a ComputeTokensResponse instance that contains tokens results.

countTokens

public CompletableFuture<CountTokensResponse> countTokens(String model,
 String text,
 CountTokensConfig config)

Asynchronously counts tokens given a GenAI model and a text string.

Parameters:

model - the name of the GenAI model to use.

text - the text string to send to count tokens for.

config - a CountTokensConfig instance that specifies the optional configurations

Returns:

a CountTokensResponse instance that contains tokens count.

computeTokens

public CompletableFuture<ComputeTokensResponse> computeTokens(String model,
 String text,
 ComputeTokensConfig config)

Asynchronously computes tokens given a GenAI model and a text string.

Parameters:

model - the name of the GenAI model to use.

text - the text string to send to count tokens for.

config - a ComputeTokensConfig instance that specifies the optional configurations

Returns:

a ComputeTokensResponse instance that contains tokens results.

generateContent

public CompletableFuture<GenerateContentResponse> generateContent(String model,
 List<Content> contents,
 GenerateContentConfig config)

Asynchronously generates content given a GenAI model and a list of content.

Parameters:

model - the name of the GenAI model to use for generation

contents - a List<Content> to send to the generative model

config - a GenerateContentConfig instance that specifies the optional configurations

Returns:

a GenerateContentResponse instance that contains response contents and other metadata

generateContent

public CompletableFuture<GenerateContentResponse> generateContent(String model,
 Content content,
 GenerateContentConfig config)

Asynchronously generates content given a GenAI model and a content object.

Parameters:

model - the name of the GenAI model to use for generation

content - a Content to send to the generative model

config - a GenerateContentConfig instance that specifies the optional configurations

Returns:

a GenerateContentResponse instance that contains response contents and other metadata

generateContent

public CompletableFuture<GenerateContentResponse> generateContent(String model,
 String text,
 GenerateContentConfig config)

Asynchronously generates content given a GenAI model and a text string.

Parameters:

model - the name of the GenAI model to use for generation

text - the text string to send to the generative model

config - a GenerateContentConfig instance that specifies the optional configurations

Returns:

a GenerateContentResponse instance that contains response contents and other metadata

generateContentStream

public CompletableFuture<ResponseStream<GenerateContentResponse>> generateContentStream(String model,
 List<Content> contents,
 GenerateContentConfig config)

Asynchronously generates content with streaming support given a GenAI model and a list of content.

Parameters:

model - the name of the GenAI model to use for generation

contents - a List<Content> to send to the generative model

config - a GenerateContentConfig instance that specifies the optional configurations

Returns:

a GenerateContentResponse instance that contains response contents and other metadata

generateContentStream

public CompletableFuture<ResponseStream<GenerateContentResponse>> generateContentStream(String model,
 Content content,
 GenerateContentConfig config)

Asynchronously generates content with streaming support given a GenAI model and a content object.

Parameters:

model - the name of the GenAI model to use for generation

content - a Content to send to the generative model

config - a GenerateContentConfig instance that specifies the optional configurations

Returns:

a GenerateContentResponse instance that contains response contents and other metadata

generateContentStream

public CompletableFuture<ResponseStream<GenerateContentResponse>> generateContentStream(String model,
 String text,
 GenerateContentConfig config)

Asynchronously generates content with streaming support given a GenAI model and a text string.

Parameters:

model - the name of the GenAI model to use for generation

text - the text string to send to the generative model

config - a GenerateContentConfig instance that specifies the optional configurations

Returns:

a GenerateContentResponse instance that contains response contents and other metadata

generateImages

public CompletableFuture<GenerateImagesResponse> generateImages(String model,
 String prompt,
 GenerateImagesConfig config)

Asynchronously generates images given a GenAI model and a prompt.

Parameters:

model - the name of the GenAI model to use for generating images

prompt - the prompt to generate images

config - a GenerateImagesConfig instance that specifies the optional configurations

Returns:

a GenerateImagesResponse instance that contains the generated images.

editImage

public CompletableFuture<EditImageResponse> editImage(String model,
 String prompt,
 List<ReferenceImage> referenceImages,
 EditImageConfig config)

Asynchronously edits an image given a GenAI model, a prompt, and a list of reference images.

Parameters:

model - the name of the GenAI model to use for editing capabilities

prompt - the prompt to edit the image

referenceImages - a List<ReferenceImage> to send to use for editing. The 5 types of reference images are: RawReferenceImage, MaskReferenceImage, ControlReferenceImage, StyleReferenceImage, SubjectReferenceImage,

config - a EditImageConfig instance that specifies the optional configurations

Returns:

a EditImageResponse instance that contains the edited image.

upscaleImage

public CompletableFuture<UpscaleImageResponse> upscaleImage(String model,
 Image image,
 String upscaleFactor,
 UpscaleImageConfig config)

Asynchronously upscales an image given a GenAI model and an image and an upscale factor.

Parameters:

model - the name of the GenAI model to use for upscaling

image - a Image to send to the generative model

upscaleFactor - the factor to upscale the image

config - a UpscaleImageConfig instance that specifies the optional configurations

Returns:

a UpscaleImageResponse instance that contains the upscaled image.

generateVideos

public CompletableFuture<GenerateVideosOperation> generateVideos(String model,
 GenerateVideosSource source,
 GenerateVideosConfig config)

Asynchronously generates videos given a GenAI model, and a GenerateVideosSource source.

This method is experimental.

Parameters:

model - the name of the GenAI model to use for generating videos

source - a GenerateVideosSource that specifies the inputs (prompt, image, and/or video) to generate videos.

config - a GenerateVideosConfig instance that specifies the optional configurations

Returns:

a GenerateVideosOperation instance that contains the generated videos.

generateVideos

public CompletableFuture<GenerateVideosOperation> generateVideos(String model,
 String prompt,
 Image image,
 Video video,
 GenerateVideosConfig config)

Asynchronously generates videos given a GenAI model, and an input (text, image, or video).

This method is experimental.

Parameters:

model - the name of the GenAI model to use for generating videos

prompt - the text prompt for generating the videos. Optional for image to video and video extension use cases.

image - the input image for generating the videos. Optional if prompt is provided.

video - the input video for video extension use cases. Optional if prompt or image is provided.

config - a GenerateVideosConfig instance that specifies the optional configurations

Returns:

a GenerateVideosOperation instance that contains the generated videos.

generateVideos

public CompletableFuture<GenerateVideosOperation> generateVideos(String model,
 String prompt,
 Image image,
 GenerateVideosConfig config)

Asynchronously generates videos given a GenAI model, and an input (text, image).

This method is experimental, and kept for backward compatibility.

Parameters:

model - the name of the GenAI model to use for generating videos

prompt - the text prompt for generating the videos. Optional for image to video use cases.

image - the input image for generating the videos. Optional if prompt is provided.

config - a GenerateVideosConfig instance that specifies the optional configurations

Returns:

a GenerateVideosOperation instance that contains the generated videos.

embedContent

public CompletableFuture<EmbedContentResponse> embedContent(String model,
 String text,
 EmbedContentConfig config)

Asynchronously embeds content given a GenAI model and a text string.

Parameters:

model - the name of the GenAI model to use for embedding

text - the text string to send to the embedding model

Returns:

a EmbedContentResponse instance that contains the embedding.

embedContent

public CompletableFuture<EmbedContentResponse> embedContent(String model,
 List<String> texts,
 EmbedContentConfig config)

Asynchronously embeds content given a GenAI model and a list of text strings.

Parameters:

model - the name of the GenAI model to use for embedding

texts - the list of text strings to send to the embedding model

Returns:

a EmbedContentResponse instance that contains the embedding.

list

public CompletableFuture<AsyncPager<Model>> list(ListModelsConfig config)

Asynchronously makes an API request to list the available models.

Parameters:

config - A ListModelsConfig for configuring the list request.

Returns:

A CompletableFuture that resolves to a AsyncPager. The AsyncPager has a `forEach` method that can be used to asynchronously process items in the page and automatically query the next page once the current page is exhausted.