Package com.google.genai

Class Models

java.lang.Object

com.google.genai.Models

public final class Models
extends Object

Provides methods for interacting with the available GenAI models. Instantiating this class is not required. After instantiating a Client, access methods through `client.models.methodName(...)` directly.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ComputeTokensResponse	computeTokens(String model, String text, ComputeTokensConfig config)	Computes tokens given a GenAI model and a text string.
ComputeTokensResponse	computeTokens(String model, List<Content> contents, ComputeTokensConfig config)
CountTokensResponse	countTokens(String model, String text, CountTokensConfig config)	Counts tokens given a GenAI model and a text string.
CountTokensResponse	countTokens(String model, List<Content> contents, CountTokensConfig config)
EditImageResponse	editImage(String model, String prompt, List<ReferenceImage> referenceImages, EditImageConfig config)	Edits an image given a GenAI model, a prompt, and a list of reference images.
EmbedContentResponse	embedContent(String model, String text, EmbedContentConfig config)	Embeds content given a GenAI model and a text string.
EmbedContentResponse	embedContent(String model, List<String> texts, EmbedContentConfig config)	Embeds content given a GenAI model and a list of text strings.
GenerateContentResponse	generateContent(String model, Content content, GenerateContentConfig config)	Generates content given a GenAI model and a content object.
GenerateContentResponse	generateContent(String model, String text, GenerateContentConfig config)	Generates content given a GenAI model and a text string.
GenerateContentResponse	generateContent(String model, List<Content> contents, GenerateContentConfig config)	Generates content given a GenAI model and a content object.
ResponseStream<GenerateContentResponse>	generateContentStream(String model, Content content, GenerateContentConfig config)	Generates content with streaming support given a GenAI model and a content object.
ResponseStream<GenerateContentResponse>	generateContentStream(String model, String text, GenerateContentConfig config)	Generates content with streaming support given a GenAI model and a text string.
ResponseStream<GenerateContentResponse>	generateContentStream(String model, List<Content> contents, GenerateContentConfig config)	Generates content with streaming support given a GenAI model and a content object.
GenerateImagesResponse	generateImages(String model, String prompt, GenerateImagesConfig config)	Generates images given a GenAI model and a prompt.
GenerateVideosOperation	generateVideos(String model, String prompt, Image image, GenerateVideosConfig config)	Generates videos given a GenAI model, and a prompt or an image.
UpscaleImageResponse	upscaleImage(String model, Image image, String upscaleFactor, UpscaleImageConfig config)	Upscales an image given a GenAI model and an image and an upscale factor.

Methods inherited from class java.lang.Object

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

Constructor Details

Models

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

Method Details

countTokens

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

computeTokens

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

generateVideos

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

Generates videos given a GenAI model, and a prompt or an image.

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 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.

generateContent

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

Generates content given a GenAI model and a content object.

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 GenerateContentResponse generateContent(String model,
 Content content,
 GenerateContentConfig config)

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 GenerateContentResponse generateContent(String model,
 String text,
 GenerateContentConfig config)

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 ResponseStream<GenerateContentResponse> generateContentStream(String model,
 List<Content> contents,
 GenerateContentConfig config)

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

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 ResponseStream<GenerateContentResponse> generateContentStream(String model,
 Content content,
 GenerateContentConfig config)

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 ResponseStream<GenerateContentResponse> generateContentStream(String model,
 String text,
 GenerateContentConfig config)

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

countTokens

public CountTokensResponse countTokens(String model,
 String text,
 CountTokensConfig config)

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 ComputeTokensResponse computeTokens(String model,
 String text,
 ComputeTokensConfig config)

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 compute tokens for.

config - a ComputeTokensConfig instance that specifies the optional configurations

Returns:

a ComputeTokensResponse instance that contains tokens results.

generateImages

public GenerateImagesResponse generateImages(String model,
 String prompt,
 GenerateImagesConfig config)

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 EditImageResponse editImage(String model,
 String prompt,
 List<ReferenceImage> referenceImages,
 EditImageConfig config)

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 UpscaleImageResponse upscaleImage(String model,
 Image image,
 String upscaleFactor,
 UpscaleImageConfig config)

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.

embedContent

public EmbedContentResponse embedContent(String model,
 String text,
 EmbedContentConfig config)

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 EmbedContentResponse embedContent(String model,
 List<String> texts,
 EmbedContentConfig config)

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.