Index

A B C D E F G H I J L M N O P R S T U V W Y
All Classes and Interfaces|All Packages

A

addWatermark() - Method in class com.google.genai.types.GenerateImagesConfig

Whether to add a watermark to the generated images.

addWatermark(boolean) - Method in class com.google.genai.types.GenerateImagesConfig.Builder

allowedFunctionNames() - Method in class com.google.genai.types.FunctionCallingConfig

Optional.

allowedFunctionNames(List<String>) - Method in class com.google.genai.types.FunctionCallingConfig.Builder

anyOf() - Method in class com.google.genai.types.Schema

Optional.

anyOf(List<Schema>) - Method in class com.google.genai.types.Schema.Builder

apiKey() - Method in class com.google.genai.Client

Returns the API key for Google AI APIs.

apiKey(String) - Method in class com.google.genai.Client.Builder

Sets the API key for Google AI APIs.

ApiResponse - Class in com.google.genai

The API response contains a response to a call to the GenAI APIs.

ApiResponse() - Constructor for class com.google.genai.ApiResponse

apiVersion() - Method in class com.google.genai.types.HttpOptions

Specifies the version of the API to use.

apiVersion(String) - Method in class com.google.genai.types.HttpOptions.Builder

args() - Method in class com.google.genai.types.FunctionCall

Optional.

args(Map<String, Object>) - Method in class com.google.genai.types.FunctionCall.Builder

aspectRatio() - Method in class com.google.genai.types.GenerateImagesConfig

Aspect ratio of the generated images.

aspectRatio(String) - Method in class com.google.genai.types.GenerateImagesConfig.Builder

async - Variable in class com.google.genai.Client

Async(ApiClient) - Constructor for class com.google.genai.Client.Async

AsyncModels - Class in com.google.genai

AsyncModels(ApiClient) - Constructor for class com.google.genai.AsyncModels

audioTimestamp() - Method in class com.google.genai.types.GenerateContentConfig

If enabled, audio timestamp will be included in the request to the model.

audioTimestamp() - Method in class com.google.genai.types.GenerationConfig

Optional.

audioTimestamp(boolean) - Method in class com.google.genai.types.GenerateContentConfig.Builder

audioTimestamp(boolean) - Method in class com.google.genai.types.GenerationConfig.Builder

autoMode() - Method in class com.google.genai.types.GenerationConfigRoutingConfig

Automated routing.

autoMode(GenerationConfigRoutingConfigAutoRoutingMode) - Method in class com.google.genai.types.GenerationConfigRoutingConfig.Builder

avgLogprobs() - Method in class com.google.genai.types.Candidate

Output only.

avgLogprobs(Double) - Method in class com.google.genai.types.Candidate.Builder

B

baseUrl() - Method in class com.google.genai.types.HttpOptions

The base URL for the AI platform service endpoint.

baseUrl(String) - Method in class com.google.genai.types.HttpOptions.Builder

Blob - Class in com.google.genai.types

Content blob.

Blob() - Constructor for class com.google.genai.types.Blob

Blob.Builder - Class in com.google.genai.types

Builder for Blob.

blocked() - Method in class com.google.genai.types.SafetyRating

Output only.

blocked(boolean) - Method in class com.google.genai.types.SafetyRating.Builder

blockReason() - Method in class com.google.genai.types.GenerateContentResponsePromptFeedback

Output only.

blockReason(String) - Method in class com.google.genai.types.GenerateContentResponsePromptFeedback.Builder

blockReasonMessage() - Method in class com.google.genai.types.GenerateContentResponsePromptFeedback

Output only.

blockReasonMessage(String) - Method in class com.google.genai.types.GenerateContentResponsePromptFeedback.Builder

bodySegments() - Method in class com.google.genai.types.ReplayRequest

bodySegments() - Method in class com.google.genai.types.ReplayResponse

bodySegments(List<Map<String, Object>>) - Method in class com.google.genai.types.ReplayRequest.Builder

bodySegments(List<Map<String, Object>>) - Method in class com.google.genai.types.ReplayResponse.Builder

build() - Method in class com.google.genai.Client.Builder

Builds the Client instance.

build() - Method in class com.google.genai.types.Blob.Builder

build() - Method in class com.google.genai.types.Candidate.Builder

build() - Method in class com.google.genai.types.Citation.Builder

build() - Method in class com.google.genai.types.CitationMetadata.Builder

build() - Method in class com.google.genai.types.CodeExecutionResult.Builder

build() - Method in class com.google.genai.types.Content.Builder

build() - Method in class com.google.genai.types.ControlReferenceConfig.Builder

build() - Method in class com.google.genai.types.ControlReferenceImage.Builder

build() - Method in class com.google.genai.types.DynamicRetrievalConfig.Builder

build() - Method in class com.google.genai.types.ExecutableCode.Builder

build() - Method in class com.google.genai.types.FileData.Builder

build() - Method in class com.google.genai.types.FunctionCall.Builder

build() - Method in class com.google.genai.types.FunctionCallingConfig.Builder

build() - Method in class com.google.genai.types.FunctionDeclaration.Builder

build() - Method in class com.google.genai.types.FunctionResponse.Builder

build() - Method in class com.google.genai.types.GenerateContentConfig.Builder

build() - Method in class com.google.genai.types.GenerateContentParameters.Builder

build() - Method in class com.google.genai.types.GenerateContentResponse.Builder

build() - Method in class com.google.genai.types.GenerateContentResponsePromptFeedback.Builder

build() - Method in class com.google.genai.types.GenerateContentResponseUsageMetadata.Builder

build() - Method in class com.google.genai.types.GeneratedImage.Builder

build() - Method in class com.google.genai.types.GenerateImagesConfig.Builder

build() - Method in class com.google.genai.types.GenerateImagesParameters.Builder

build() - Method in class com.google.genai.types.GenerateImagesResponse.Builder

build() - Method in class com.google.genai.types.GenerationConfig.Builder

build() - Method in class com.google.genai.types.GenerationConfigRoutingConfig.Builder

build() - Method in class com.google.genai.types.GenerationConfigRoutingConfigAutoRoutingMode.Builder

build() - Method in class com.google.genai.types.GenerationConfigRoutingConfigManualRoutingMode.Builder

build() - Method in class com.google.genai.types.GoogleSearch.Builder

build() - Method in class com.google.genai.types.GoogleSearchRetrieval.Builder

build() - Method in class com.google.genai.types.GoogleTypeDate.Builder

build() - Method in class com.google.genai.types.GroundingChunk.Builder

build() - Method in class com.google.genai.types.GroundingChunkRetrievedContext.Builder

build() - Method in class com.google.genai.types.GroundingChunkWeb.Builder

build() - Method in class com.google.genai.types.GroundingMetadata.Builder

build() - Method in class com.google.genai.types.GroundingSupport.Builder

build() - Method in class com.google.genai.types.HttpOptions.Builder

build() - Method in class com.google.genai.types.Image.Builder

build() - Method in class com.google.genai.types.LogprobsResult.Builder

build() - Method in class com.google.genai.types.LogprobsResultCandidate.Builder

build() - Method in class com.google.genai.types.LogprobsResultTopCandidates.Builder

build() - Method in class com.google.genai.types.MaskReferenceConfig.Builder

build() - Method in class com.google.genai.types.MaskReferenceImage.Builder

build() - Method in class com.google.genai.types.Part.Builder

build() - Method in class com.google.genai.types.PrebuiltVoiceConfig.Builder

build() - Method in class com.google.genai.types.RawReferenceImage.Builder

build() - Method in class com.google.genai.types.ReplayFile.Builder

build() - Method in class com.google.genai.types.ReplayInteraction.Builder

build() - Method in class com.google.genai.types.ReplayRequest.Builder

build() - Method in class com.google.genai.types.ReplayResponse.Builder

build() - Method in class com.google.genai.types.Retrieval.Builder

build() - Method in class com.google.genai.types.RetrievalMetadata.Builder

build() - Method in class com.google.genai.types.SafetyRating.Builder

build() - Method in class com.google.genai.types.SafetySetting.Builder

build() - Method in class com.google.genai.types.Schema.Builder

build() - Method in class com.google.genai.types.SearchEntryPoint.Builder

build() - Method in class com.google.genai.types.Segment.Builder

build() - Method in class com.google.genai.types.SpeechConfig.Builder

build() - Method in class com.google.genai.types.StyleReferenceConfig.Builder

build() - Method in class com.google.genai.types.StyleReferenceImage.Builder

build() - Method in class com.google.genai.types.SubjectReferenceConfig.Builder

build() - Method in class com.google.genai.types.SubjectReferenceImage.Builder

build() - Method in class com.google.genai.types.TestTableFile.Builder

build() - Method in class com.google.genai.types.TestTableItem.Builder

build() - Method in class com.google.genai.types.ThinkingConfig.Builder

build() - Method in class com.google.genai.types.Tool.Builder

build() - Method in class com.google.genai.types.ToolCodeExecution.Builder

build() - Method in class com.google.genai.types.ToolConfig.Builder

build() - Method in class com.google.genai.types.UploadFileConfig.Builder

build() - Method in class com.google.genai.types.UpscaleImageAPIConfig.Builder

build() - Method in class com.google.genai.types.UpscaleImageAPIParameters.Builder

build() - Method in class com.google.genai.types.UpscaleImageConfig.Builder

build() - Method in class com.google.genai.types.UpscaleImageParameters.Builder

build() - Method in class com.google.genai.types.UpscaleImageResponse.Builder

build() - Method in class com.google.genai.types.VertexAISearch.Builder

build() - Method in class com.google.genai.types.VertexRagStore.Builder

build() - Method in class com.google.genai.types.VertexRagStoreRagResource.Builder

build() - Method in class com.google.genai.types.VideoMetadata.Builder

build() - Method in class com.google.genai.types.VoiceConfig.Builder

builder() - Static method in class com.google.genai.Client

Returns a Client.Builder for Client.

builder() - Static method in class com.google.genai.types.Blob

Instantiates a builder for Blob.

builder() - Static method in class com.google.genai.types.Candidate

Instantiates a builder for Candidate.

builder() - Static method in class com.google.genai.types.Citation

Instantiates a builder for Citation.

builder() - Static method in class com.google.genai.types.CitationMetadata

Instantiates a builder for CitationMetadata.

builder() - Static method in class com.google.genai.types.CodeExecutionResult

Instantiates a builder for CodeExecutionResult.

builder() - Static method in class com.google.genai.types.Content

Instantiates a builder for Content.

builder() - Static method in class com.google.genai.types.ControlReferenceConfig

Instantiates a builder for ControlReferenceConfig.

builder() - Static method in class com.google.genai.types.ControlReferenceImage

Instantiates a builder for ControlReferenceImage.

builder() - Static method in class com.google.genai.types.DynamicRetrievalConfig

Instantiates a builder for DynamicRetrievalConfig.

builder() - Static method in class com.google.genai.types.ExecutableCode

Instantiates a builder for ExecutableCode.

builder() - Static method in class com.google.genai.types.FileData

Instantiates a builder for FileData.

builder() - Static method in class com.google.genai.types.FunctionCall

Instantiates a builder for FunctionCall.

builder() - Static method in class com.google.genai.types.FunctionCallingConfig

Instantiates a builder for FunctionCallingConfig.

builder() - Static method in class com.google.genai.types.FunctionDeclaration

Instantiates a builder for FunctionDeclaration.

builder() - Static method in class com.google.genai.types.FunctionResponse

Instantiates a builder for FunctionResponse.

builder() - Static method in class com.google.genai.types.GenerateContentConfig

Instantiates a builder for GenerateContentConfig.

builder() - Static method in class com.google.genai.types.GenerateContentParameters

Instantiates a builder for GenerateContentParameters.

builder() - Static method in class com.google.genai.types.GenerateContentResponse

Instantiates a builder for GenerateContentResponse.

builder() - Static method in class com.google.genai.types.GenerateContentResponsePromptFeedback

Instantiates a builder for GenerateContentResponsePromptFeedback.

builder() - Static method in class com.google.genai.types.GenerateContentResponseUsageMetadata

Instantiates a builder for GenerateContentResponseUsageMetadata.

builder() - Static method in class com.google.genai.types.GeneratedImage

Instantiates a builder for GeneratedImage.

builder() - Static method in class com.google.genai.types.GenerateImagesConfig

Instantiates a builder for GenerateImagesConfig.

builder() - Static method in class com.google.genai.types.GenerateImagesParameters

Instantiates a builder for GenerateImagesParameters.

builder() - Static method in class com.google.genai.types.GenerateImagesResponse

Instantiates a builder for GenerateImagesResponse.

builder() - Static method in class com.google.genai.types.GenerationConfig

Instantiates a builder for GenerationConfig.

builder() - Static method in class com.google.genai.types.GenerationConfigRoutingConfig

Instantiates a builder for GenerationConfigRoutingConfig.

builder() - Static method in class com.google.genai.types.GenerationConfigRoutingConfigAutoRoutingMode

Instantiates a builder for GenerationConfigRoutingConfigAutoRoutingMode.

builder() - Static method in class com.google.genai.types.GenerationConfigRoutingConfigManualRoutingMode

Instantiates a builder for GenerationConfigRoutingConfigManualRoutingMode.

builder() - Static method in class com.google.genai.types.GoogleSearch

Instantiates a builder for GoogleSearch.

builder() - Static method in class com.google.genai.types.GoogleSearchRetrieval

Instantiates a builder for GoogleSearchRetrieval.

builder() - Static method in class com.google.genai.types.GoogleTypeDate

Instantiates a builder for GoogleTypeDate.

builder() - Static method in class com.google.genai.types.GroundingChunk

Instantiates a builder for GroundingChunk.

builder() - Static method in class com.google.genai.types.GroundingChunkRetrievedContext

Instantiates a builder for GroundingChunkRetrievedContext.

builder() - Static method in class com.google.genai.types.GroundingChunkWeb

Instantiates a builder for GroundingChunkWeb.

builder() - Static method in class com.google.genai.types.GroundingMetadata

Instantiates a builder for GroundingMetadata.

builder() - Static method in class com.google.genai.types.GroundingSupport

Instantiates a builder for GroundingSupport.

builder() - Static method in class com.google.genai.types.HttpOptions

Instantiates a builder for HttpOptions.

builder() - Static method in class com.google.genai.types.Image

Instantiates a builder for Image.

builder() - Static method in class com.google.genai.types.LogprobsResult

Instantiates a builder for LogprobsResult.

builder() - Static method in class com.google.genai.types.LogprobsResultCandidate

Instantiates a builder for LogprobsResultCandidate.

builder() - Static method in class com.google.genai.types.LogprobsResultTopCandidates

Instantiates a builder for LogprobsResultTopCandidates.

builder() - Static method in class com.google.genai.types.MaskReferenceConfig

Instantiates a builder for MaskReferenceConfig.

builder() - Static method in class com.google.genai.types.MaskReferenceImage

Instantiates a builder for MaskReferenceImage.

builder() - Static method in class com.google.genai.types.Part

Instantiates a builder for Part.

builder() - Static method in class com.google.genai.types.PrebuiltVoiceConfig

Instantiates a builder for PrebuiltVoiceConfig.

builder() - Static method in class com.google.genai.types.RawReferenceImage

Instantiates a builder for RawReferenceImage.

builder() - Static method in class com.google.genai.types.ReplayFile

Instantiates a builder for ReplayFile.

builder() - Static method in class com.google.genai.types.ReplayInteraction

Instantiates a builder for ReplayInteraction.

builder() - Static method in class com.google.genai.types.ReplayRequest

Instantiates a builder for ReplayRequest.

builder() - Static method in class com.google.genai.types.ReplayResponse

Instantiates a builder for ReplayResponse.

builder() - Static method in class com.google.genai.types.Retrieval

Instantiates a builder for Retrieval.

builder() - Static method in class com.google.genai.types.RetrievalMetadata

Instantiates a builder for RetrievalMetadata.

builder() - Static method in class com.google.genai.types.SafetyRating

Instantiates a builder for SafetyRating.

builder() - Static method in class com.google.genai.types.SafetySetting

Instantiates a builder for SafetySetting.

builder() - Static method in class com.google.genai.types.Schema

Instantiates a builder for Schema.

builder() - Static method in class com.google.genai.types.SearchEntryPoint

Instantiates a builder for SearchEntryPoint.

builder() - Static method in class com.google.genai.types.Segment

Instantiates a builder for Segment.

builder() - Static method in class com.google.genai.types.SpeechConfig

Instantiates a builder for SpeechConfig.

builder() - Static method in class com.google.genai.types.StyleReferenceConfig

Instantiates a builder for StyleReferenceConfig.

builder() - Static method in class com.google.genai.types.StyleReferenceImage

Instantiates a builder for StyleReferenceImage.

builder() - Static method in class com.google.genai.types.SubjectReferenceConfig

Instantiates a builder for SubjectReferenceConfig.

builder() - Static method in class com.google.genai.types.SubjectReferenceImage

Instantiates a builder for SubjectReferenceImage.

builder() - Static method in class com.google.genai.types.TestTableFile

Instantiates a builder for TestTableFile.

builder() - Static method in class com.google.genai.types.TestTableItem

Instantiates a builder for TestTableItem.

builder() - Static method in class com.google.genai.types.ThinkingConfig

Instantiates a builder for ThinkingConfig.

builder() - Static method in class com.google.genai.types.Tool

Instantiates a builder for Tool.

builder() - Static method in class com.google.genai.types.ToolCodeExecution

Instantiates a builder for ToolCodeExecution.

builder() - Static method in class com.google.genai.types.ToolConfig

Instantiates a builder for ToolConfig.

builder() - Static method in class com.google.genai.types.UploadFileConfig

Instantiates a builder for UploadFileConfig.

builder() - Static method in class com.google.genai.types.UpscaleImageAPIConfig

Instantiates a builder for UpscaleImageAPIConfig.

builder() - Static method in class com.google.genai.types.UpscaleImageAPIParameters

Instantiates a builder for UpscaleImageAPIParameters.

builder() - Static method in class com.google.genai.types.UpscaleImageConfig

Instantiates a builder for UpscaleImageConfig.

builder() - Static method in class com.google.genai.types.UpscaleImageParameters

Instantiates a builder for UpscaleImageParameters.

builder() - Static method in class com.google.genai.types.UpscaleImageResponse

Instantiates a builder for UpscaleImageResponse.

builder() - Static method in class com.google.genai.types.VertexAISearch

Instantiates a builder for VertexAISearch.

builder() - Static method in class com.google.genai.types.VertexRagStore

Instantiates a builder for VertexRagStore.

builder() - Static method in class com.google.genai.types.VertexRagStoreRagResource

Instantiates a builder for VertexRagStoreRagResource.

builder() - Static method in class com.google.genai.types.VideoMetadata

Instantiates a builder for VideoMetadata.

builder() - Static method in class com.google.genai.types.VoiceConfig

Instantiates a builder for VoiceConfig.

Builder() - Constructor for class com.google.genai.Client.Builder

Builder() - Constructor for class com.google.genai.types.Blob.Builder

Builder() - Constructor for class com.google.genai.types.Candidate.Builder

Builder() - Constructor for class com.google.genai.types.Citation.Builder

Builder() - Constructor for class com.google.genai.types.CitationMetadata.Builder

Builder() - Constructor for class com.google.genai.types.CodeExecutionResult.Builder

Builder() - Constructor for class com.google.genai.types.Content.Builder

Builder() - Constructor for class com.google.genai.types.ControlReferenceConfig.Builder

Builder() - Constructor for class com.google.genai.types.ControlReferenceImage.Builder

Builder() - Constructor for class com.google.genai.types.DynamicRetrievalConfig.Builder

Builder() - Constructor for class com.google.genai.types.ExecutableCode.Builder

Builder() - Constructor for class com.google.genai.types.FileData.Builder

Builder() - Constructor for class com.google.genai.types.FunctionCall.Builder

Builder() - Constructor for class com.google.genai.types.FunctionCallingConfig.Builder

Builder() - Constructor for class com.google.genai.types.FunctionDeclaration.Builder

Builder() - Constructor for class com.google.genai.types.FunctionResponse.Builder

Builder() - Constructor for class com.google.genai.types.GenerateContentConfig.Builder

Builder() - Constructor for class com.google.genai.types.GenerateContentParameters.Builder

Builder() - Constructor for class com.google.genai.types.GenerateContentResponse.Builder

Builder() - Constructor for class com.google.genai.types.GenerateContentResponsePromptFeedback.Builder

Builder() - Constructor for class com.google.genai.types.GenerateContentResponseUsageMetadata.Builder

Builder() - Constructor for class com.google.genai.types.GeneratedImage.Builder

Builder() - Constructor for class com.google.genai.types.GenerateImagesConfig.Builder

Builder() - Constructor for class com.google.genai.types.GenerateImagesParameters.Builder

Builder() - Constructor for class com.google.genai.types.GenerateImagesResponse.Builder

Builder() - Constructor for class com.google.genai.types.GenerationConfig.Builder

Builder() - Constructor for class com.google.genai.types.GenerationConfigRoutingConfig.Builder

Builder() - Constructor for class com.google.genai.types.GenerationConfigRoutingConfigAutoRoutingMode.Builder

Builder() - Constructor for class com.google.genai.types.GenerationConfigRoutingConfigManualRoutingMode.Builder

Builder() - Constructor for class com.google.genai.types.GoogleSearch.Builder

Builder() - Constructor for class com.google.genai.types.GoogleSearchRetrieval.Builder

Builder() - Constructor for class com.google.genai.types.GoogleTypeDate.Builder

Builder() - Constructor for class com.google.genai.types.GroundingChunk.Builder

Builder() - Constructor for class com.google.genai.types.GroundingChunkRetrievedContext.Builder

Builder() - Constructor for class com.google.genai.types.GroundingChunkWeb.Builder

Builder() - Constructor for class com.google.genai.types.GroundingMetadata.Builder

Builder() - Constructor for class com.google.genai.types.GroundingSupport.Builder

Builder() - Constructor for class com.google.genai.types.HttpOptions.Builder

Builder() - Constructor for class com.google.genai.types.Image.Builder

Builder() - Constructor for class com.google.genai.types.LogprobsResult.Builder

Builder() - Constructor for class com.google.genai.types.LogprobsResultCandidate.Builder

Builder() - Constructor for class com.google.genai.types.LogprobsResultTopCandidates.Builder

Builder() - Constructor for class com.google.genai.types.MaskReferenceConfig.Builder

Builder() - Constructor for class com.google.genai.types.MaskReferenceImage.Builder

Builder() - Constructor for class com.google.genai.types.Part.Builder

Builder() - Constructor for class com.google.genai.types.PrebuiltVoiceConfig.Builder

Builder() - Constructor for class com.google.genai.types.RawReferenceImage.Builder

Builder() - Constructor for class com.google.genai.types.ReplayFile.Builder

Builder() - Constructor for class com.google.genai.types.ReplayInteraction.Builder

Builder() - Constructor for class com.google.genai.types.ReplayRequest.Builder

Builder() - Constructor for class com.google.genai.types.ReplayResponse.Builder

Builder() - Constructor for class com.google.genai.types.Retrieval.Builder

Builder() - Constructor for class com.google.genai.types.RetrievalMetadata.Builder

Builder() - Constructor for class com.google.genai.types.SafetyRating.Builder

Builder() - Constructor for class com.google.genai.types.SafetySetting.Builder

Builder() - Constructor for class com.google.genai.types.Schema.Builder

Builder() - Constructor for class com.google.genai.types.SearchEntryPoint.Builder

Builder() - Constructor for class com.google.genai.types.Segment.Builder

Builder() - Constructor for class com.google.genai.types.SpeechConfig.Builder

Builder() - Constructor for class com.google.genai.types.StyleReferenceConfig.Builder

Builder() - Constructor for class com.google.genai.types.StyleReferenceImage.Builder

Builder() - Constructor for class com.google.genai.types.SubjectReferenceConfig.Builder

Builder() - Constructor for class com.google.genai.types.SubjectReferenceImage.Builder

Builder() - Constructor for class com.google.genai.types.TestTableFile.Builder

Builder() - Constructor for class com.google.genai.types.TestTableItem.Builder

Builder() - Constructor for class com.google.genai.types.ThinkingConfig.Builder

Builder() - Constructor for class com.google.genai.types.Tool.Builder

Builder() - Constructor for class com.google.genai.types.ToolCodeExecution.Builder

Builder() - Constructor for class com.google.genai.types.ToolConfig.Builder

Builder() - Constructor for class com.google.genai.types.UploadFileConfig.Builder

Builder() - Constructor for class com.google.genai.types.UpscaleImageAPIConfig.Builder

Builder() - Constructor for class com.google.genai.types.UpscaleImageAPIParameters.Builder

Builder() - Constructor for class com.google.genai.types.UpscaleImageConfig.Builder

Builder() - Constructor for class com.google.genai.types.UpscaleImageParameters.Builder

Builder() - Constructor for class com.google.genai.types.UpscaleImageResponse.Builder

Builder() - Constructor for class com.google.genai.types.VertexAISearch.Builder

Builder() - Constructor for class com.google.genai.types.VertexRagStore.Builder

Builder() - Constructor for class com.google.genai.types.VertexRagStoreRagResource.Builder

Builder() - Constructor for class com.google.genai.types.VideoMetadata.Builder

Builder() - Constructor for class com.google.genai.types.VoiceConfig.Builder

C

cachedContent() - Method in class com.google.genai.types.GenerateContentConfig

Resource name of a context cache that can be used in subsequent requests.

cachedContent(String) - Method in class com.google.genai.types.GenerateContentConfig.Builder

cachedContentTokenCount() - Method in class com.google.genai.types.GenerateContentResponseUsageMetadata

Output only.

cachedContentTokenCount(Integer) - Method in class com.google.genai.types.GenerateContentResponseUsageMetadata.Builder

Candidate - Class in com.google.genai.types

A response candidate generated from the model.

Candidate() - Constructor for class com.google.genai.types.Candidate

Candidate.Builder - Class in com.google.genai.types

Builder for Candidate.

candidateCount() - Method in class com.google.genai.types.GenerateContentConfig

Number of response variations to return.

candidateCount() - Method in class com.google.genai.types.GenerationConfig

Optional.

candidateCount(Integer) - Method in class com.google.genai.types.GenerateContentConfig.Builder

candidateCount(Integer) - Method in class com.google.genai.types.GenerationConfig.Builder

candidates() - Method in class com.google.genai.types.GenerateContentResponse

Response variations returned by the model.

candidates() - Method in class com.google.genai.types.LogprobsResultTopCandidates

Sorted by log probability in descending order.

candidates(List<Candidate>) - Method in class com.google.genai.types.GenerateContentResponse.Builder

candidates(List<LogprobsResultCandidate>) - Method in class com.google.genai.types.LogprobsResultTopCandidates.Builder

candidatesTokenCount() - Method in class com.google.genai.types.GenerateContentResponseUsageMetadata

Number of tokens in the response(s).

candidatesTokenCount(Integer) - Method in class com.google.genai.types.GenerateContentResponseUsageMetadata.Builder

category() - Method in class com.google.genai.types.SafetyRating

Output only.

category() - Method in class com.google.genai.types.SafetySetting

Required.

category(String) - Method in class com.google.genai.types.SafetyRating.Builder

category(String) - Method in class com.google.genai.types.SafetySetting.Builder

chosenCandidates() - Method in class com.google.genai.types.LogprobsResult

Length = total number of decoding steps.

chosenCandidates(List<LogprobsResultCandidate>) - Method in class com.google.genai.types.LogprobsResult.Builder

Citation - Class in com.google.genai.types

Source attributions for content.

Citation() - Constructor for class com.google.genai.types.Citation

Citation.Builder - Class in com.google.genai.types

Builder for Citation.

citationMetadata() - Method in class com.google.genai.types.Candidate

Source attribution of the generated content.

citationMetadata(CitationMetadata) - Method in class com.google.genai.types.Candidate.Builder

CitationMetadata - Class in com.google.genai.types

Citation information when the model quotes another source.

CitationMetadata() - Constructor for class com.google.genai.types.CitationMetadata

CitationMetadata.Builder - Class in com.google.genai.types

Builder for CitationMetadata.

citations() - Method in class com.google.genai.types.CitationMetadata

Contains citation information when the model directly quotes, at length, from another source.

citations(List<Citation>) - Method in class com.google.genai.types.CitationMetadata.Builder

Client - Class in com.google.genai

Client class for GenAI.

Client() - Constructor for class com.google.genai.Client

Constructs a Client instance with environment variables.

Client.Async - Class in com.google.genai

Async class for GenAI.

Client.Builder - Class in com.google.genai

Builder for Client.

close() - Method in class com.google.genai.ApiResponse

close() - Method in class com.google.genai.Client

Closes the Client instance together with its instantiated http client.

close() - Method in class com.google.genai.ResponseStream

code() - Method in class com.google.genai.types.ExecutableCode

Required.

code(String) - Method in class com.google.genai.types.ExecutableCode.Builder

codeExecution() - Method in class com.google.genai.types.Tool

Optional.

codeExecution(ToolCodeExecution) - Method in class com.google.genai.types.Tool.Builder

codeExecutionResult() - Method in class com.google.genai.types.GenerateContentResponse

Returns the code execution result in the response.

codeExecutionResult() - Method in class com.google.genai.types.Part

Optional.

codeExecutionResult(CodeExecutionResult) - Method in class com.google.genai.types.Part.Builder

CodeExecutionResult - Class in com.google.genai.types

Result of executing the [ExecutableCode].

CodeExecutionResult() - Constructor for class com.google.genai.types.CodeExecutionResult

CodeExecutionResult.Builder - Class in com.google.genai.types

Builder for CodeExecutionResult.

com.google.genai - package com.google.genai

com.google.genai.types - package com.google.genai.types

comment() - Method in class com.google.genai.types.TestTableFile

comment(String) - Method in class com.google.genai.types.TestTableFile.Builder

Common - Class in com.google.genai

Common utility methods for the GenAI SDK.

confidenceScores() - Method in class com.google.genai.types.GroundingSupport

Confidence score of the support references.

confidenceScores(List<Float>) - Method in class com.google.genai.types.GroundingSupport.Builder

config() - Method in class com.google.genai.types.ControlReferenceImage

Configuration for the control reference image.

config() - Method in class com.google.genai.types.GenerateContentParameters

Configuration that contains optional model parameters.

config() - Method in class com.google.genai.types.GenerateImagesParameters

Configuration for generating images.

config() - Method in class com.google.genai.types.MaskReferenceImage

Configuration for the mask reference image.

config() - Method in class com.google.genai.types.StyleReferenceImage

Configuration for the style reference image.

config() - Method in class com.google.genai.types.SubjectReferenceImage

Configuration for the subject reference image.

config() - Method in class com.google.genai.types.UpscaleImageAPIParameters

Configuration for upscaling.

config() - Method in class com.google.genai.types.UpscaleImageParameters

Configuration for upscaling.

config(ControlReferenceConfig) - Method in class com.google.genai.types.ControlReferenceImage.Builder

config(GenerateContentConfig) - Method in class com.google.genai.types.GenerateContentParameters.Builder

config(GenerateImagesConfig) - Method in class com.google.genai.types.GenerateImagesParameters.Builder

config(MaskReferenceConfig) - Method in class com.google.genai.types.MaskReferenceImage.Builder

config(StyleReferenceConfig) - Method in class com.google.genai.types.StyleReferenceImage.Builder

config(SubjectReferenceConfig) - Method in class com.google.genai.types.SubjectReferenceImage.Builder

config(UpscaleImageAPIConfig) - Method in class com.google.genai.types.UpscaleImageAPIParameters.Builder

config(UpscaleImageConfig) - Method in class com.google.genai.types.UpscaleImageParameters.Builder

content() - Method in class com.google.genai.types.Candidate

Contains the multi-part content of the response.

content(Content) - Method in class com.google.genai.types.Candidate.Builder

Content - Class in com.google.genai.types

Contains the multi-part content of a message.

Content() - Constructor for class com.google.genai.types.Content

Content.Builder - Class in com.google.genai.types

Builder for Content.

contents() - Method in class com.google.genai.types.GenerateContentParameters

Content of the request.

contents(List<Content>) - Method in class com.google.genai.types.GenerateContentParameters.Builder

ControlReferenceConfig - Class in com.google.genai.types

Configuration for a Control reference image.

ControlReferenceConfig() - Constructor for class com.google.genai.types.ControlReferenceConfig

ControlReferenceConfig.Builder - Class in com.google.genai.types

Builder for ControlReferenceConfig.

ControlReferenceImage - Class in com.google.genai.types

A control reference image.

ControlReferenceImage() - Constructor for class com.google.genai.types.ControlReferenceImage

ControlReferenceImage.Builder - Class in com.google.genai.types

Builder for ControlReferenceImage.

controlType() - Method in class com.google.genai.types.ControlReferenceConfig

The type of control reference image to use.

controlType(String) - Method in class com.google.genai.types.ControlReferenceConfig.Builder

credentials(GoogleCredentials) - Method in class com.google.genai.Client.Builder

Sets the GoogleCredentials for Vertex AI APIs.

D

data() - Method in class com.google.genai.types.Blob

Required.

data(String) - Method in class com.google.genai.types.Blob.Builder

datastore() - Method in class com.google.genai.types.VertexAISearch

Required.

datastore(String) - Method in class com.google.genai.types.VertexAISearch.Builder

day() - Method in class com.google.genai.types.GoogleTypeDate

Day of a month.

day(Integer) - Method in class com.google.genai.types.GoogleTypeDate.Builder

default_() - Method in class com.google.genai.types.Schema

Optional.

default_(Object) - Method in class com.google.genai.types.Schema.Builder

description() - Method in class com.google.genai.types.FunctionDeclaration

Optional.

description() - Method in class com.google.genai.types.Schema

Optional.

description(String) - Method in class com.google.genai.types.FunctionDeclaration.Builder

description(String) - Method in class com.google.genai.types.Schema.Builder

disableAttribution() - Method in class com.google.genai.types.Retrieval

Optional.

disableAttribution(boolean) - Method in class com.google.genai.types.Retrieval.Builder

displayName() - Method in class com.google.genai.types.UploadFileConfig

Optional display name of the file.

displayName(String) - Method in class com.google.genai.types.UploadFileConfig.Builder

dynamicRetrievalConfig() - Method in class com.google.genai.types.GoogleSearchRetrieval

Specifies the dynamic retrieval configuration for the given source.

dynamicRetrievalConfig(DynamicRetrievalConfig) - Method in class com.google.genai.types.GoogleSearchRetrieval.Builder

DynamicRetrievalConfig - Class in com.google.genai.types

Describes the options to customize dynamic retrieval.

DynamicRetrievalConfig() - Constructor for class com.google.genai.types.DynamicRetrievalConfig

DynamicRetrievalConfig.Builder - Class in com.google.genai.types

Builder for DynamicRetrievalConfig.

dynamicThreshold() - Method in class com.google.genai.types.DynamicRetrievalConfig

Optional.

dynamicThreshold(Float) - Method in class com.google.genai.types.DynamicRetrievalConfig.Builder

E

enableControlImageComputation() - Method in class com.google.genai.types.ControlReferenceConfig

Defaults to False.

enableControlImageComputation(boolean) - Method in class com.google.genai.types.ControlReferenceConfig.Builder

endIndex() - Method in class com.google.genai.types.Citation

Output only.

endIndex() - Method in class com.google.genai.types.Segment

Output only.

endIndex(Integer) - Method in class com.google.genai.types.Citation.Builder

endIndex(Integer) - Method in class com.google.genai.types.Segment.Builder

endOffset() - Method in class com.google.genai.types.VideoMetadata

Optional.

endOffset(String) - Method in class com.google.genai.types.VideoMetadata.Builder

enhancedPrompt() - Method in class com.google.genai.types.GeneratedImage

The rewritten prompt used for the image generation if the prompt enhancer is enabled.

enhancedPrompt(String) - Method in class com.google.genai.types.GeneratedImage.Builder

enhancePrompt() - Method in class com.google.genai.types.GenerateImagesConfig

Whether to use the prompt rewriting logic.

enhancePrompt(boolean) - Method in class com.google.genai.types.GenerateImagesConfig.Builder

enum_() - Method in class com.google.genai.types.Schema

Optional.

enum_(List<String>) - Method in class com.google.genai.types.Schema.Builder

example() - Method in class com.google.genai.types.Schema

Optional.

example(Object) - Method in class com.google.genai.types.Schema.Builder

exceptionIfMldev() - Method in class com.google.genai.types.TestTableItem

Expects an exception for MLDev matching the string.

exceptionIfMldev(String) - Method in class com.google.genai.types.TestTableItem.Builder

exceptionIfVertex() - Method in class com.google.genai.types.TestTableItem

Expects an exception for Vertex matching the string.

exceptionIfVertex(String) - Method in class com.google.genai.types.TestTableItem.Builder

executableCode() - Method in class com.google.genai.types.GenerateContentResponse

Returns the executable code in the response.

executableCode() - Method in class com.google.genai.types.Part

Optional.

executableCode(ExecutableCode) - Method in class com.google.genai.types.Part.Builder

ExecutableCode - Class in com.google.genai.types

Code generated by the model that is meant to be executed, and the result returned to the model.

ExecutableCode() - Constructor for class com.google.genai.types.ExecutableCode

ExecutableCode.Builder - Class in com.google.genai.types

Builder for ExecutableCode.

F

fileData() - Method in class com.google.genai.types.Part

Optional.

fileData(FileData) - Method in class com.google.genai.types.Part.Builder

FileData - Class in com.google.genai.types

URI based data.

FileData() - Constructor for class com.google.genai.types.FileData

FileData.Builder - Class in com.google.genai.types

Builder for FileData.

fileUri() - Method in class com.google.genai.types.FileData

Required.

fileUri(String) - Method in class com.google.genai.types.FileData.Builder

finishMessage() - Method in class com.google.genai.types.Candidate

Describes the reason the model stopped generating tokens.

finishMessage(String) - Method in class com.google.genai.types.Candidate.Builder

finishReason() - Method in class com.google.genai.types.Candidate

Output only.

finishReason(String) - Method in class com.google.genai.types.Candidate.Builder

format() - Method in class com.google.genai.types.Schema

Optional.

format(String) - Method in class com.google.genai.types.Schema.Builder

frequencyPenalty() - Method in class com.google.genai.types.GenerateContentConfig

Positive values penalize tokens that repeatedly appear in the generated text, increasing the probability of generating more diverse content.

frequencyPenalty() - Method in class com.google.genai.types.GenerationConfig

Optional.

frequencyPenalty(Float) - Method in class com.google.genai.types.GenerateContentConfig.Builder

frequencyPenalty(Float) - Method in class com.google.genai.types.GenerationConfig.Builder

fromJson(String) - Static method in class com.google.genai.types.Blob

Deserializes a JSON string to a Blob object.

fromJson(String) - Static method in class com.google.genai.types.Candidate

Deserializes a JSON string to a Candidate object.

fromJson(String) - Static method in class com.google.genai.types.Citation

Deserializes a JSON string to a Citation object.

fromJson(String) - Static method in class com.google.genai.types.CitationMetadata

Deserializes a JSON string to a CitationMetadata object.

fromJson(String) - Static method in class com.google.genai.types.CodeExecutionResult

Deserializes a JSON string to a CodeExecutionResult object.

fromJson(String) - Static method in class com.google.genai.types.Content

Deserializes a JSON string to a Content object.

fromJson(String) - Static method in class com.google.genai.types.ControlReferenceConfig

Deserializes a JSON string to a ControlReferenceConfig object.

fromJson(String) - Static method in class com.google.genai.types.ControlReferenceImage

Deserializes a JSON string to a ControlReferenceImage object.

fromJson(String) - Static method in class com.google.genai.types.DynamicRetrievalConfig

Deserializes a JSON string to a DynamicRetrievalConfig object.

fromJson(String) - Static method in class com.google.genai.types.ExecutableCode

Deserializes a JSON string to a ExecutableCode object.

fromJson(String) - Static method in class com.google.genai.types.FileData

Deserializes a JSON string to a FileData object.

fromJson(String) - Static method in class com.google.genai.types.FunctionCall

Deserializes a JSON string to a FunctionCall object.

fromJson(String) - Static method in class com.google.genai.types.FunctionCallingConfig

Deserializes a JSON string to a FunctionCallingConfig object.

fromJson(String) - Static method in class com.google.genai.types.FunctionDeclaration

Deserializes a JSON string to a FunctionDeclaration object.

fromJson(String) - Static method in class com.google.genai.types.FunctionResponse

Deserializes a JSON string to a FunctionResponse object.

fromJson(String) - Static method in class com.google.genai.types.GenerateContentConfig

Deserializes a JSON string to a GenerateContentConfig object.

fromJson(String) - Static method in class com.google.genai.types.GenerateContentParameters

Deserializes a JSON string to a GenerateContentParameters object.

fromJson(String) - Static method in class com.google.genai.types.GenerateContentResponse

Deserializes a JSON string to a GenerateContentResponse object.

fromJson(String) - Static method in class com.google.genai.types.GenerateContentResponsePromptFeedback

Deserializes a JSON string to a GenerateContentResponsePromptFeedback object.

fromJson(String) - Static method in class com.google.genai.types.GenerateContentResponseUsageMetadata

Deserializes a JSON string to a GenerateContentResponseUsageMetadata object.

fromJson(String) - Static method in class com.google.genai.types.GeneratedImage

Deserializes a JSON string to a GeneratedImage object.

fromJson(String) - Static method in class com.google.genai.types.GenerateImagesConfig

Deserializes a JSON string to a GenerateImagesConfig object.

fromJson(String) - Static method in class com.google.genai.types.GenerateImagesParameters

Deserializes a JSON string to a GenerateImagesParameters object.

fromJson(String) - Static method in class com.google.genai.types.GenerateImagesResponse

Deserializes a JSON string to a GenerateImagesResponse object.

fromJson(String) - Static method in class com.google.genai.types.GenerationConfig

Deserializes a JSON string to a GenerationConfig object.

fromJson(String) - Static method in class com.google.genai.types.GenerationConfigRoutingConfig

Deserializes a JSON string to a GenerationConfigRoutingConfig object.

fromJson(String) - Static method in class com.google.genai.types.GenerationConfigRoutingConfigAutoRoutingMode

Deserializes a JSON string to a GenerationConfigRoutingConfigAutoRoutingMode object.

fromJson(String) - Static method in class com.google.genai.types.GenerationConfigRoutingConfigManualRoutingMode

Deserializes a JSON string to a GenerationConfigRoutingConfigManualRoutingMode object.

fromJson(String) - Static method in class com.google.genai.types.GoogleSearch

Deserializes a JSON string to a GoogleSearch object.

fromJson(String) - Static method in class com.google.genai.types.GoogleSearchRetrieval

Deserializes a JSON string to a GoogleSearchRetrieval object.

fromJson(String) - Static method in class com.google.genai.types.GoogleTypeDate

Deserializes a JSON string to a GoogleTypeDate object.

fromJson(String) - Static method in class com.google.genai.types.GroundingChunk

Deserializes a JSON string to a GroundingChunk object.

fromJson(String) - Static method in class com.google.genai.types.GroundingChunkRetrievedContext

Deserializes a JSON string to a GroundingChunkRetrievedContext object.

fromJson(String) - Static method in class com.google.genai.types.GroundingChunkWeb

Deserializes a JSON string to a GroundingChunkWeb object.

fromJson(String) - Static method in class com.google.genai.types.GroundingMetadata

Deserializes a JSON string to a GroundingMetadata object.

fromJson(String) - Static method in class com.google.genai.types.GroundingSupport

Deserializes a JSON string to a GroundingSupport object.

fromJson(String) - Static method in class com.google.genai.types.HttpOptions

Deserializes a JSON string to a HttpOptions object.

fromJson(String) - Static method in class com.google.genai.types.Image

Deserializes a JSON string to a Image object.

fromJson(String) - Static method in class com.google.genai.types.LogprobsResult

Deserializes a JSON string to a LogprobsResult object.

fromJson(String) - Static method in class com.google.genai.types.LogprobsResultCandidate

Deserializes a JSON string to a LogprobsResultCandidate object.

fromJson(String) - Static method in class com.google.genai.types.LogprobsResultTopCandidates

Deserializes a JSON string to a LogprobsResultTopCandidates object.

fromJson(String) - Static method in class com.google.genai.types.MaskReferenceConfig

Deserializes a JSON string to a MaskReferenceConfig object.

fromJson(String) - Static method in class com.google.genai.types.MaskReferenceImage

Deserializes a JSON string to a MaskReferenceImage object.

fromJson(String) - Static method in class com.google.genai.types.Part

Deserializes a JSON string to a Part object.

fromJson(String) - Static method in class com.google.genai.types.PrebuiltVoiceConfig

Deserializes a JSON string to a PrebuiltVoiceConfig object.

fromJson(String) - Static method in class com.google.genai.types.RawReferenceImage

Deserializes a JSON string to a RawReferenceImage object.

fromJson(String) - Static method in class com.google.genai.types.ReplayFile

Deserializes a JSON string to a ReplayFile object.

fromJson(String) - Static method in class com.google.genai.types.ReplayInteraction

Deserializes a JSON string to a ReplayInteraction object.

fromJson(String) - Static method in class com.google.genai.types.ReplayRequest

Deserializes a JSON string to a ReplayRequest object.

fromJson(String) - Static method in class com.google.genai.types.ReplayResponse

Deserializes a JSON string to a ReplayResponse object.

fromJson(String) - Static method in class com.google.genai.types.Retrieval

Deserializes a JSON string to a Retrieval object.

fromJson(String) - Static method in class com.google.genai.types.RetrievalMetadata

Deserializes a JSON string to a RetrievalMetadata object.

fromJson(String) - Static method in class com.google.genai.types.SafetyRating

Deserializes a JSON string to a SafetyRating object.

fromJson(String) - Static method in class com.google.genai.types.SafetySetting

Deserializes a JSON string to a SafetySetting object.

fromJson(String) - Static method in class com.google.genai.types.Schema

Deserializes a JSON string to a Schema object.

fromJson(String) - Static method in class com.google.genai.types.SearchEntryPoint

Deserializes a JSON string to a SearchEntryPoint object.

fromJson(String) - Static method in class com.google.genai.types.Segment

Deserializes a JSON string to a Segment object.

fromJson(String) - Static method in class com.google.genai.types.SpeechConfig

Deserializes a JSON string to a SpeechConfig object.

fromJson(String) - Static method in class com.google.genai.types.StyleReferenceConfig

Deserializes a JSON string to a StyleReferenceConfig object.

fromJson(String) - Static method in class com.google.genai.types.StyleReferenceImage

Deserializes a JSON string to a StyleReferenceImage object.

fromJson(String) - Static method in class com.google.genai.types.SubjectReferenceConfig

Deserializes a JSON string to a SubjectReferenceConfig object.

fromJson(String) - Static method in class com.google.genai.types.SubjectReferenceImage

Deserializes a JSON string to a SubjectReferenceImage object.

fromJson(String) - Static method in class com.google.genai.types.TestTableFile

Deserializes a JSON string to a TestTableFile object.

fromJson(String) - Static method in class com.google.genai.types.TestTableItem

Deserializes a JSON string to a TestTableItem object.

fromJson(String) - Static method in class com.google.genai.types.ThinkingConfig

Deserializes a JSON string to a ThinkingConfig object.

fromJson(String) - Static method in class com.google.genai.types.Tool

Deserializes a JSON string to a Tool object.

fromJson(String) - Static method in class com.google.genai.types.ToolCodeExecution

Deserializes a JSON string to a ToolCodeExecution object.

fromJson(String) - Static method in class com.google.genai.types.ToolConfig

Deserializes a JSON string to a ToolConfig object.

fromJson(String) - Static method in class com.google.genai.types.UploadFileConfig

Deserializes a JSON string to a UploadFileConfig object.

fromJson(String) - Static method in class com.google.genai.types.UpscaleImageAPIConfig

Deserializes a JSON string to a UpscaleImageAPIConfig object.

fromJson(String) - Static method in class com.google.genai.types.UpscaleImageAPIParameters

Deserializes a JSON string to a UpscaleImageAPIParameters object.

fromJson(String) - Static method in class com.google.genai.types.UpscaleImageConfig

Deserializes a JSON string to a UpscaleImageConfig object.

fromJson(String) - Static method in class com.google.genai.types.UpscaleImageParameters

Deserializes a JSON string to a UpscaleImageParameters object.

fromJson(String) - Static method in class com.google.genai.types.UpscaleImageResponse

Deserializes a JSON string to a UpscaleImageResponse object.

fromJson(String) - Static method in class com.google.genai.types.VertexAISearch

Deserializes a JSON string to a VertexAISearch object.

fromJson(String) - Static method in class com.google.genai.types.VertexRagStore

Deserializes a JSON string to a VertexRagStore object.

fromJson(String) - Static method in class com.google.genai.types.VertexRagStoreRagResource

Deserializes a JSON string to a VertexRagStoreRagResource object.

fromJson(String) - Static method in class com.google.genai.types.VideoMetadata

Deserializes a JSON string to a VideoMetadata object.

fromJson(String) - Static method in class com.google.genai.types.VoiceConfig

Deserializes a JSON string to a VoiceConfig object.

fromJsonNode(JsonNode, Class<T>) - Static method in class com.google.genai.JsonSerializable

Deserializes a JsonNode to an object of the given type.

fromJsonString(String, Class<T>) - Static method in class com.google.genai.JsonSerializable

Deserializes a Json string to an object of the given type.

functionCall() - Method in class com.google.genai.types.Part

Optional.

functionCall(FunctionCall) - Method in class com.google.genai.types.Part.Builder

FunctionCall - Class in com.google.genai.types

A function call.

FunctionCall() - Constructor for class com.google.genai.types.FunctionCall

FunctionCall.Builder - Class in com.google.genai.types

Builder for FunctionCall.

functionCallingConfig() - Method in class com.google.genai.types.ToolConfig

Optional.

functionCallingConfig(FunctionCallingConfig) - Method in class com.google.genai.types.ToolConfig.Builder

FunctionCallingConfig - Class in com.google.genai.types

Function calling config.

FunctionCallingConfig() - Constructor for class com.google.genai.types.FunctionCallingConfig

FunctionCallingConfig.Builder - Class in com.google.genai.types

Builder for FunctionCallingConfig.

functionCalls() - Method in class com.google.genai.types.GenerateContentResponse

Returns the list of function calls in the response.

FunctionDeclaration - Class in com.google.genai.types

Defines a function that the model can generate JSON inputs for.

FunctionDeclaration() - Constructor for class com.google.genai.types.FunctionDeclaration

FunctionDeclaration.Builder - Class in com.google.genai.types

Builder for FunctionDeclaration.

functionDeclarations() - Method in class com.google.genai.types.Tool

List of function declarations that the tool supports.

functionDeclarations(List<FunctionDeclaration>) - Method in class com.google.genai.types.Tool.Builder

functionResponse() - Method in class com.google.genai.types.Part

Optional.

functionResponse(FunctionResponse) - Method in class com.google.genai.types.Part.Builder

FunctionResponse - Class in com.google.genai.types

A function response.

FunctionResponse() - Constructor for class com.google.genai.types.FunctionResponse

FunctionResponse.Builder - Class in com.google.genai.types

Builder for FunctionResponse.

G

gcsUri() - Method in class com.google.genai.types.Image

The Cloud Storage URI of the image.

gcsUri(String) - Method in class com.google.genai.types.Image.Builder

generateContent(String, Content, GenerateContentConfig) - Method in class com.google.genai.AsyncModels

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

generateContent(String, Content, GenerateContentConfig) - Method in class com.google.genai.Models

Generates content given a GenAI model and a content object.

generateContent(String, String, GenerateContentConfig) - Method in class com.google.genai.AsyncModels

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

generateContent(String, String, GenerateContentConfig) - Method in class com.google.genai.Models

Generates content given a GenAI model and a text string.

generateContent(String, List<Content>, GenerateContentConfig) - Method in class com.google.genai.AsyncModels

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

generateContent(String, List<Content>, GenerateContentConfig) - Method in class com.google.genai.Models

Generates content given a GenAI model and a content object.

GenerateContentConfig - Class in com.google.genai.types

Optional model configuration parameters.

GenerateContentConfig() - Constructor for class com.google.genai.types.GenerateContentConfig

GenerateContentConfig.Builder - Class in com.google.genai.types

Builder for GenerateContentConfig.

GenerateContentParameters - Class in com.google.genai.types

Config for models.generate_content parameters.

GenerateContentParameters() - Constructor for class com.google.genai.types.GenerateContentParameters

GenerateContentParameters.Builder - Class in com.google.genai.types

Builder for GenerateContentParameters.

GenerateContentResponse - Class in com.google.genai.types

Response message for PredictionService.GenerateContent.

GenerateContentResponse() - Constructor for class com.google.genai.types.GenerateContentResponse

GenerateContentResponse.Builder - Class in com.google.genai.types

Builder for GenerateContentResponse.

GenerateContentResponsePromptFeedback - Class in com.google.genai.types

Content filter results for a prompt sent in the request.

GenerateContentResponsePromptFeedback() - Constructor for class com.google.genai.types.GenerateContentResponsePromptFeedback

GenerateContentResponsePromptFeedback.Builder - Class in com.google.genai.types

Builder for GenerateContentResponsePromptFeedback.

GenerateContentResponseUsageMetadata - Class in com.google.genai.types

Usage metadata about response(s).

GenerateContentResponseUsageMetadata() - Constructor for class com.google.genai.types.GenerateContentResponseUsageMetadata

GenerateContentResponseUsageMetadata.Builder - Class in com.google.genai.types

Builder for GenerateContentResponseUsageMetadata.

generateContentStream(String, Content, GenerateContentConfig) - Method in class com.google.genai.AsyncModels

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

generateContentStream(String, Content, GenerateContentConfig) - Method in class com.google.genai.Models

Generates content with streaming support given a GenAI model and a content object.

generateContentStream(String, String, GenerateContentConfig) - Method in class com.google.genai.AsyncModels

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

generateContentStream(String, String, GenerateContentConfig) - Method in class com.google.genai.Models

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

generateContentStream(String, List<Content>, GenerateContentConfig) - Method in class com.google.genai.AsyncModels

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

generateContentStream(String, List<Content>, GenerateContentConfig) - Method in class com.google.genai.Models

Generates content with streaming support given a GenAI model and a content object.

GeneratedImage - Class in com.google.genai.types

An output image.

GeneratedImage() - Constructor for class com.google.genai.types.GeneratedImage

GeneratedImage.Builder - Class in com.google.genai.types

Builder for GeneratedImage.

generatedImages() - Method in class com.google.genai.types.GenerateImagesResponse

List of generated images.

generatedImages() - Method in class com.google.genai.types.UpscaleImageResponse

Generated images.

generatedImages(List<GeneratedImage>) - Method in class com.google.genai.types.GenerateImagesResponse.Builder

generatedImages(List<GeneratedImage>) - Method in class com.google.genai.types.UpscaleImageResponse.Builder

generateImages(String, String, GenerateImagesConfig) - Method in class com.google.genai.AsyncModels

generateImages(String, String, GenerateImagesConfig) - Method in class com.google.genai.Models

GenerateImagesConfig - Class in com.google.genai.types

The config for generating an images.

GenerateImagesConfig() - Constructor for class com.google.genai.types.GenerateImagesConfig

GenerateImagesConfig.Builder - Class in com.google.genai.types

Builder for GenerateImagesConfig.

GenerateImagesParameters - Class in com.google.genai.types

The parameters for generating images.

GenerateImagesParameters() - Constructor for class com.google.genai.types.GenerateImagesParameters

GenerateImagesParameters.Builder - Class in com.google.genai.types

Builder for GenerateImagesParameters.

GenerateImagesResponse - Class in com.google.genai.types

The output images response.

GenerateImagesResponse() - Constructor for class com.google.genai.types.GenerateImagesResponse

GenerateImagesResponse.Builder - Class in com.google.genai.types

Builder for GenerateImagesResponse.

GenerationConfig - Class in com.google.genai.types

Generation config.

GenerationConfig() - Constructor for class com.google.genai.types.GenerationConfig

GenerationConfig.Builder - Class in com.google.genai.types

Builder for GenerationConfig.

GenerationConfigRoutingConfig - Class in com.google.genai.types

The configuration for routing the request to a specific model.

GenerationConfigRoutingConfig() - Constructor for class com.google.genai.types.GenerationConfigRoutingConfig

GenerationConfigRoutingConfig.Builder - Class in com.google.genai.types

Builder for GenerationConfigRoutingConfig.

GenerationConfigRoutingConfigAutoRoutingMode - Class in com.google.genai.types

When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference.

GenerationConfigRoutingConfigAutoRoutingMode() - Constructor for class com.google.genai.types.GenerationConfigRoutingConfigAutoRoutingMode

GenerationConfigRoutingConfigAutoRoutingMode.Builder - Class in com.google.genai.types

Builder for GenerationConfigRoutingConfigAutoRoutingMode.

GenerationConfigRoutingConfigManualRoutingMode - Class in com.google.genai.types

When manual routing is set, the specified model will be used directly.

GenerationConfigRoutingConfigManualRoutingMode() - Constructor for class com.google.genai.types.GenerationConfigRoutingConfigManualRoutingMode

GenerationConfigRoutingConfigManualRoutingMode.Builder - Class in com.google.genai.types

Builder for GenerationConfigRoutingConfigManualRoutingMode.

getEntity() - Method in class com.google.genai.ApiResponse

Gets the HttpEntity.

googleSearch() - Method in class com.google.genai.types.Tool

Optional.

googleSearch(GoogleSearch) - Method in class com.google.genai.types.Tool.Builder

GoogleSearch - Class in com.google.genai.types

Tool to support Google Search in Model.

GoogleSearch() - Constructor for class com.google.genai.types.GoogleSearch

GoogleSearch.Builder - Class in com.google.genai.types

Builder for GoogleSearch.

googleSearchDynamicRetrievalScore() - Method in class com.google.genai.types.RetrievalMetadata

Optional.

googleSearchDynamicRetrievalScore(Float) - Method in class com.google.genai.types.RetrievalMetadata.Builder

googleSearchRetrieval() - Method in class com.google.genai.types.Tool

Optional.

googleSearchRetrieval(GoogleSearchRetrieval) - Method in class com.google.genai.types.Tool.Builder

GoogleSearchRetrieval - Class in com.google.genai.types

Tool to retrieve public web data for grounding, powered by Google.

GoogleSearchRetrieval() - Constructor for class com.google.genai.types.GoogleSearchRetrieval

GoogleSearchRetrieval.Builder - Class in com.google.genai.types

Builder for GoogleSearchRetrieval.

GoogleTypeDate - Class in com.google.genai.types

Represents a whole or partial calendar date, such as a birthday.

GoogleTypeDate() - Constructor for class com.google.genai.types.GoogleTypeDate

GoogleTypeDate.Builder - Class in com.google.genai.types

Builder for GoogleTypeDate.

GroundingChunk - Class in com.google.genai.types

Grounding chunk.

GroundingChunk() - Constructor for class com.google.genai.types.GroundingChunk

GroundingChunk.Builder - Class in com.google.genai.types

Builder for GroundingChunk.

groundingChunkIndices() - Method in class com.google.genai.types.GroundingSupport

A list of indices (into 'grounding_chunk') specifying the citations associated with the claim.

groundingChunkIndices(List<Integer>) - Method in class com.google.genai.types.GroundingSupport.Builder

GroundingChunkRetrievedContext - Class in com.google.genai.types

Chunk from context retrieved by the retrieval tools.

GroundingChunkRetrievedContext() - Constructor for class com.google.genai.types.GroundingChunkRetrievedContext

GroundingChunkRetrievedContext.Builder - Class in com.google.genai.types

Builder for GroundingChunkRetrievedContext.

groundingChunks() - Method in class com.google.genai.types.GroundingMetadata

List of supporting references retrieved from specified grounding source.

groundingChunks(List<GroundingChunk>) - Method in class com.google.genai.types.GroundingMetadata.Builder

GroundingChunkWeb - Class in com.google.genai.types

Chunk from the web.

GroundingChunkWeb() - Constructor for class com.google.genai.types.GroundingChunkWeb

GroundingChunkWeb.Builder - Class in com.google.genai.types

Builder for GroundingChunkWeb.

groundingMetadata() - Method in class com.google.genai.types.Candidate

Output only.

groundingMetadata(GroundingMetadata) - Method in class com.google.genai.types.Candidate.Builder

GroundingMetadata - Class in com.google.genai.types

Metadata returned to client when grounding is enabled.

GroundingMetadata() - Constructor for class com.google.genai.types.GroundingMetadata

GroundingMetadata.Builder - Class in com.google.genai.types

Builder for GroundingMetadata.

GroundingSupport - Class in com.google.genai.types

Grounding support.

GroundingSupport() - Constructor for class com.google.genai.types.GroundingSupport

GroundingSupport.Builder - Class in com.google.genai.types

Builder for GroundingSupport.

groundingSupports() - Method in class com.google.genai.types.GroundingMetadata

Optional.

groundingSupports(List<GroundingSupport>) - Method in class com.google.genai.types.GroundingMetadata.Builder

guidanceScale() - Method in class com.google.genai.types.GenerateImagesConfig

Controls how much the model adheres to the text prompt.

guidanceScale(Float) - Method in class com.google.genai.types.GenerateImagesConfig.Builder

H

hasUnion() - Method in class com.google.genai.types.TestTableItem

True if the parameters contain an unsupported union type.

hasUnion(boolean) - Method in class com.google.genai.types.TestTableItem.Builder

headers() - Method in class com.google.genai.types.HttpOptions

Additional HTTP headers to be sent with the request.

headers() - Method in class com.google.genai.types.ReplayRequest

headers() - Method in class com.google.genai.types.ReplayResponse

headers(Map<String, String>) - Method in class com.google.genai.types.HttpOptions.Builder

headers(Map<String, String>) - Method in class com.google.genai.types.ReplayRequest.Builder

headers(Map<String, String>) - Method in class com.google.genai.types.ReplayResponse.Builder

httpOptions(HttpOptions) - Method in class com.google.genai.Client.Builder

Sets the HttpOptions for the API client.

HttpOptions - Class in com.google.genai.types

HTTP options to be used in each of the requests.

HttpOptions() - Constructor for class com.google.genai.types.HttpOptions

HttpOptions.Builder - Class in com.google.genai.types

Builder for HttpOptions.

I

id() - Method in class com.google.genai.types.FunctionCall

The unique id of the function call.

id() - Method in class com.google.genai.types.FunctionResponse

The id of the function call this response is for.

id(String) - Method in class com.google.genai.types.FunctionCall.Builder

id(String) - Method in class com.google.genai.types.FunctionResponse.Builder

image() - Method in class com.google.genai.types.GeneratedImage

The output image data.

image() - Method in class com.google.genai.types.UpscaleImageAPIParameters

The input image to upscale.

image() - Method in class com.google.genai.types.UpscaleImageParameters

The input image to upscale.

image(Image) - Method in class com.google.genai.types.GeneratedImage.Builder

image(Image) - Method in class com.google.genai.types.UpscaleImageAPIParameters.Builder

image(Image) - Method in class com.google.genai.types.UpscaleImageParameters.Builder

Image - Class in com.google.genai.types

An image.

Image() - Constructor for class com.google.genai.types.Image

Image.Builder - Class in com.google.genai.types

Builder for Image.

imageBytes() - Method in class com.google.genai.types.Image

The image bytes data.

imageBytes(String) - Method in class com.google.genai.types.Image.Builder

includeRaiReason() - Method in class com.google.genai.types.GenerateImagesConfig

Whether to include the Responsible AI filter reason if the image is filtered out of the response.

includeRaiReason() - Method in class com.google.genai.types.UpscaleImageAPIConfig

Whether to include a reason for filtered-out images in the response.

includeRaiReason() - Method in class com.google.genai.types.UpscaleImageConfig

Whether to include a reason for filtered-out images in the response.

includeRaiReason(boolean) - Method in class com.google.genai.types.GenerateImagesConfig.Builder

includeRaiReason(boolean) - Method in class com.google.genai.types.UpscaleImageAPIConfig.Builder

includeRaiReason(boolean) - Method in class com.google.genai.types.UpscaleImageConfig.Builder

includeSafetyAttributes() - Method in class com.google.genai.types.GenerateImagesConfig

Whether to report the safety scores of each image in the response.

includeSafetyAttributes(boolean) - Method in class com.google.genai.types.GenerateImagesConfig.Builder

includeThoughts() - Method in class com.google.genai.types.ThinkingConfig

Indicates whether to include thoughts in the response.

includeThoughts(boolean) - Method in class com.google.genai.types.ThinkingConfig.Builder

index() - Method in class com.google.genai.types.Candidate

Output only.

index(Integer) - Method in class com.google.genai.types.Candidate.Builder

inlineData() - Method in class com.google.genai.types.Part

Optional.

inlineData(Blob) - Method in class com.google.genai.types.Part.Builder

interactions() - Method in class com.google.genai.types.ReplayFile

interactions(List<ReplayInteraction>) - Method in class com.google.genai.types.ReplayFile.Builder

isVertexAI() - Method in class com.google.genai.Client

Returns whether the client is using Vertex AI APIs.

items() - Method in class com.google.genai.types.Schema

Optional.

items(Schema) - Method in class com.google.genai.types.Schema.Builder

iterator() - Method in class com.google.genai.ResponseStream

J

JsonSerializable - Class in com.google.genai

A class that can be serialized to JSON and deserialized from JSON.

JsonSerializable() - Constructor for class com.google.genai.JsonSerializable

L

labels() - Method in class com.google.genai.types.GenerateContentConfig

Labels with user-defined metadata to break down billed charges.

labels(Map<String, String>) - Method in class com.google.genai.types.GenerateContentConfig.Builder

language() - Method in class com.google.genai.types.ExecutableCode

Required.

language() - Method in class com.google.genai.types.GenerateImagesConfig

Language of the text in the prompt.

language(String) - Method in class com.google.genai.types.ExecutableCode.Builder

language(String) - Method in class com.google.genai.types.GenerateImagesConfig.Builder

license() - Method in class com.google.genai.types.Citation

Output only.

license(String) - Method in class com.google.genai.types.Citation.Builder

location() - Method in class com.google.genai.Client

Returns the location for Vertex AI APIs.

location(String) - Method in class com.google.genai.Client.Builder

Sets the location for Vertex AI APIs.

logProbability() - Method in class com.google.genai.types.LogprobsResultCandidate

The candidate's log probability.

logProbability(Float) - Method in class com.google.genai.types.LogprobsResultCandidate.Builder

logprobs() - Method in class com.google.genai.types.GenerateContentConfig

Number of top candidate tokens to return the log probabilities for at each generation step.

logprobs() - Method in class com.google.genai.types.GenerationConfig

Optional.

logprobs(Integer) - Method in class com.google.genai.types.GenerateContentConfig.Builder

logprobs(Integer) - Method in class com.google.genai.types.GenerationConfig.Builder

logprobsResult() - Method in class com.google.genai.types.Candidate

Output only.

logprobsResult(LogprobsResult) - Method in class com.google.genai.types.Candidate.Builder

LogprobsResult - Class in com.google.genai.types

Logprobs Result

LogprobsResult() - Constructor for class com.google.genai.types.LogprobsResult

LogprobsResult.Builder - Class in com.google.genai.types

Builder for LogprobsResult.

LogprobsResultCandidate - Class in com.google.genai.types

Candidate for the logprobs token and score.

LogprobsResultCandidate() - Constructor for class com.google.genai.types.LogprobsResultCandidate

LogprobsResultCandidate.Builder - Class in com.google.genai.types

Builder for LogprobsResultCandidate.

LogprobsResultTopCandidates - Class in com.google.genai.types

Candidates with top log probabilities at each decoding step.

LogprobsResultTopCandidates() - Constructor for class com.google.genai.types.LogprobsResultTopCandidates

LogprobsResultTopCandidates.Builder - Class in com.google.genai.types

Builder for LogprobsResultTopCandidates.

M

manualMode() - Method in class com.google.genai.types.GenerationConfigRoutingConfig

Manual routing.

manualMode(GenerationConfigRoutingConfigManualRoutingMode) - Method in class com.google.genai.types.GenerationConfigRoutingConfig.Builder

maskDilation() - Method in class com.google.genai.types.MaskReferenceConfig

Dilation percentage of the mask provided.

maskDilation(Float) - Method in class com.google.genai.types.MaskReferenceConfig.Builder

maskMode() - Method in class com.google.genai.types.MaskReferenceConfig

Prompts the model to generate a mask instead of you needing to provide one (unless MASK_MODE_USER_PROVIDED is used).

maskMode(String) - Method in class com.google.genai.types.MaskReferenceConfig.Builder

MaskReferenceConfig - Class in com.google.genai.types

Configuration for a Mask reference image.

MaskReferenceConfig() - Constructor for class com.google.genai.types.MaskReferenceConfig

MaskReferenceConfig.Builder - Class in com.google.genai.types

Builder for MaskReferenceConfig.

MaskReferenceImage - Class in com.google.genai.types

A mask reference image.

MaskReferenceImage() - Constructor for class com.google.genai.types.MaskReferenceImage

MaskReferenceImage.Builder - Class in com.google.genai.types

Builder for MaskReferenceImage.

maximum() - Method in class com.google.genai.types.Schema

Optional.

maximum(Double) - Method in class com.google.genai.types.Schema.Builder

maxItems() - Method in class com.google.genai.types.Schema

Optional.

maxItems(Long) - Method in class com.google.genai.types.Schema.Builder

maxLength() - Method in class com.google.genai.types.Schema

Optional.

maxLength(Long) - Method in class com.google.genai.types.Schema.Builder

maxOutputTokens() - Method in class com.google.genai.types.GenerateContentConfig

Maximum number of tokens that can be generated in the response.

maxOutputTokens() - Method in class com.google.genai.types.GenerationConfig

Optional.

maxOutputTokens(Integer) - Method in class com.google.genai.types.GenerateContentConfig.Builder

maxOutputTokens(Integer) - Method in class com.google.genai.types.GenerationConfig.Builder

maxProperties() - Method in class com.google.genai.types.Schema

Optional.

maxProperties(Long) - Method in class com.google.genai.types.Schema.Builder

mediaResolution() - Method in class com.google.genai.types.GenerateContentConfig

If specified, the media resolution specified will be used.

mediaResolution(String) - Method in class com.google.genai.types.GenerateContentConfig.Builder

method() - Method in class com.google.genai.types.ReplayRequest

method() - Method in class com.google.genai.types.SafetySetting

Determines if the harm block method uses probability or probability and severity scores.

method(String) - Method in class com.google.genai.types.ReplayRequest.Builder

method(String) - Method in class com.google.genai.types.SafetySetting.Builder

mimeType() - Method in class com.google.genai.types.Blob

Required.

mimeType() - Method in class com.google.genai.types.FileData

Required.

mimeType() - Method in class com.google.genai.types.Image

The MIME type of the image.

mimeType() - Method in class com.google.genai.types.UploadFileConfig

mime_type: The MIME type of the file.

mimeType(String) - Method in class com.google.genai.types.Blob.Builder

mimeType(String) - Method in class com.google.genai.types.FileData.Builder

mimeType(String) - Method in class com.google.genai.types.Image.Builder

mimeType(String) - Method in class com.google.genai.types.UploadFileConfig.Builder

minimum() - Method in class com.google.genai.types.Schema

Optional.

minimum(Double) - Method in class com.google.genai.types.Schema.Builder

minItems() - Method in class com.google.genai.types.Schema

Optional.

minItems(Long) - Method in class com.google.genai.types.Schema.Builder

minLength() - Method in class com.google.genai.types.Schema

Optional.

minLength(Long) - Method in class com.google.genai.types.Schema.Builder

minProperties() - Method in class com.google.genai.types.Schema

Optional.

minProperties(Long) - Method in class com.google.genai.types.Schema.Builder

mode() - Method in class com.google.genai.types.DynamicRetrievalConfig

The mode of the predictor to be used in dynamic retrieval.

mode() - Method in class com.google.genai.types.FunctionCallingConfig

Optional.

mode() - Method in class com.google.genai.types.UpscaleImageAPIConfig

mode(String) - Method in class com.google.genai.types.DynamicRetrievalConfig.Builder

mode(String) - Method in class com.google.genai.types.FunctionCallingConfig.Builder

mode(String) - Method in class com.google.genai.types.UpscaleImageAPIConfig.Builder

model() - Method in class com.google.genai.types.GenerateContentParameters

ID of the model to use.

model() - Method in class com.google.genai.types.GenerateImagesParameters

ID of the model to use.

model() - Method in class com.google.genai.types.UpscaleImageAPIParameters

The model to use.

model() - Method in class com.google.genai.types.UpscaleImageParameters

The model to use.

model(String) - Method in class com.google.genai.types.GenerateContentParameters.Builder

model(String) - Method in class com.google.genai.types.GenerateImagesParameters.Builder

model(String) - Method in class com.google.genai.types.UpscaleImageAPIParameters.Builder

model(String) - Method in class com.google.genai.types.UpscaleImageParameters.Builder

modelName() - Method in class com.google.genai.types.GenerationConfigRoutingConfigManualRoutingMode

The model name to use.

modelName(String) - Method in class com.google.genai.types.GenerationConfigRoutingConfigManualRoutingMode.Builder

modelRoutingPreference() - Method in class com.google.genai.types.GenerationConfigRoutingConfigAutoRoutingMode

The model routing preference.

modelRoutingPreference(String) - Method in class com.google.genai.types.GenerationConfigRoutingConfigAutoRoutingMode.Builder

models - Variable in class com.google.genai.Client.Async

models - Variable in class com.google.genai.Client

Models - Class in com.google.genai

Models(ApiClient) - Constructor for class com.google.genai.Models

modelVersion() - Method in class com.google.genai.types.GenerateContentResponse

Output only.

modelVersion(String) - Method in class com.google.genai.types.GenerateContentResponse.Builder

month() - Method in class com.google.genai.types.GoogleTypeDate

Month of a year.

month(Integer) - Method in class com.google.genai.types.GoogleTypeDate.Builder

N

name() - Method in class com.google.genai.types.FunctionCall

Required.

name() - Method in class com.google.genai.types.FunctionDeclaration

Required.

name() - Method in class com.google.genai.types.FunctionResponse

Required.

name() - Method in class com.google.genai.types.TestTableItem

The name of the test.

name() - Method in class com.google.genai.types.UploadFileConfig

The name of the file in the destination (e.g., 'files/sample-image'.

name(String) - Method in class com.google.genai.types.FunctionCall.Builder

name(String) - Method in class com.google.genai.types.FunctionDeclaration.Builder

name(String) - Method in class com.google.genai.types.FunctionResponse.Builder

name(String) - Method in class com.google.genai.types.TestTableItem.Builder

name(String) - Method in class com.google.genai.types.UploadFileConfig.Builder

negativePrompt() - Method in class com.google.genai.types.GenerateImagesConfig

Description of what to discourage in the generated images.

negativePrompt(String) - Method in class com.google.genai.types.GenerateImagesConfig.Builder

nullable() - Method in class com.google.genai.types.Schema

Optional.

nullable(boolean) - Method in class com.google.genai.types.Schema.Builder

numberOfImages() - Method in class com.google.genai.types.GenerateImagesConfig

Number of images to generate.

numberOfImages() - Method in class com.google.genai.types.UpscaleImageAPIConfig

numberOfImages(Integer) - Method in class com.google.genai.types.GenerateImagesConfig.Builder

numberOfImages(Integer) - Method in class com.google.genai.types.UpscaleImageAPIConfig.Builder

O

objectMapper - Static variable in class com.google.genai.JsonSerializable

outcome() - Method in class com.google.genai.types.CodeExecutionResult

Required.

outcome(String) - Method in class com.google.genai.types.CodeExecutionResult.Builder

output() - Method in class com.google.genai.types.CodeExecutionResult

Optional.

output(String) - Method in class com.google.genai.types.CodeExecutionResult.Builder

outputCompressionQuality() - Method in class com.google.genai.types.GenerateImagesConfig

Compression quality of the generated image (for ``image/jpeg`` only).

outputCompressionQuality() - Method in class com.google.genai.types.UpscaleImageAPIConfig

The level of compression if the ``output_mime_type`` is ``image/jpeg``.

outputCompressionQuality() - Method in class com.google.genai.types.UpscaleImageConfig

The level of compression if the ``output_mime_type`` is ``image/jpeg``.

outputCompressionQuality(Integer) - Method in class com.google.genai.types.GenerateImagesConfig.Builder

outputCompressionQuality(Integer) - Method in class com.google.genai.types.UpscaleImageAPIConfig.Builder

outputCompressionQuality(Integer) - Method in class com.google.genai.types.UpscaleImageConfig.Builder

outputGcsUri() - Method in class com.google.genai.types.GenerateImagesConfig

Cloud Storage URI used to store the generated images.

outputGcsUri(String) - Method in class com.google.genai.types.GenerateImagesConfig.Builder

outputMimeType() - Method in class com.google.genai.types.GenerateImagesConfig

MIME type of the generated image.

outputMimeType() - Method in class com.google.genai.types.UpscaleImageAPIConfig

The image format that the output should be saved as.

outputMimeType() - Method in class com.google.genai.types.UpscaleImageConfig

The image format that the output should be saved as.

outputMimeType(String) - Method in class com.google.genai.types.GenerateImagesConfig.Builder

outputMimeType(String) - Method in class com.google.genai.types.UpscaleImageAPIConfig.Builder

outputMimeType(String) - Method in class com.google.genai.types.UpscaleImageConfig.Builder

overrideReplayId() - Method in class com.google.genai.types.TestTableItem

Use if you don't want to use the default replay id which is derived from the test name.

overrideReplayId(String) - Method in class com.google.genai.types.TestTableItem.Builder

P

parameterNames() - Method in class com.google.genai.types.TestTableFile

parameterNames(List<String>) - Method in class com.google.genai.types.TestTableFile.Builder

parameters() - Method in class com.google.genai.types.FunctionDeclaration

Optional.

parameters() - Method in class com.google.genai.types.TestTableItem

The parameters to the test.

parameters(Schema) - Method in class com.google.genai.types.FunctionDeclaration.Builder

parameters(Map<String, Object>) - Method in class com.google.genai.types.TestTableItem.Builder

Part - Class in com.google.genai.types

A datatype containing media content.

Part() - Constructor for class com.google.genai.types.Part

Part.Builder - Class in com.google.genai.types

Builder for Part.

partIndex() - Method in class com.google.genai.types.Segment

Output only.

partIndex(Integer) - Method in class com.google.genai.types.Segment.Builder

parts() - Method in class com.google.genai.types.Content

List of parts that constitute a single message.

parts() - Method in class com.google.genai.types.GenerateContentResponse

Returns the list of parts in the first candidate of the response.

parts(List<Part>) - Method in class com.google.genai.types.Content.Builder

pattern() - Method in class com.google.genai.types.Schema

Optional.

pattern(String) - Method in class com.google.genai.types.Schema.Builder

personGeneration() - Method in class com.google.genai.types.GenerateImagesConfig

Allows generation of people by the model.

personGeneration(String) - Method in class com.google.genai.types.GenerateImagesConfig.Builder

prebuiltVoiceConfig() - Method in class com.google.genai.types.VoiceConfig

The configuration for the speaker to use.

prebuiltVoiceConfig(PrebuiltVoiceConfig) - Method in class com.google.genai.types.VoiceConfig.Builder

PrebuiltVoiceConfig - Class in com.google.genai.types

The configuration for the prebuilt speaker to use.

PrebuiltVoiceConfig() - Constructor for class com.google.genai.types.PrebuiltVoiceConfig

PrebuiltVoiceConfig.Builder - Class in com.google.genai.types

Builder for PrebuiltVoiceConfig.

presencePenalty() - Method in class com.google.genai.types.GenerateContentConfig

Positive values penalize tokens that already appear in the generated text, increasing the probability of generating more diverse content.

presencePenalty() - Method in class com.google.genai.types.GenerationConfig

Optional.

presencePenalty(Float) - Method in class com.google.genai.types.GenerateContentConfig.Builder

presencePenalty(Float) - Method in class com.google.genai.types.GenerationConfig.Builder

probability() - Method in class com.google.genai.types.SafetyRating

Output only.

probability(String) - Method in class com.google.genai.types.SafetyRating.Builder

probabilityScore() - Method in class com.google.genai.types.SafetyRating

Output only.

probabilityScore(Float) - Method in class com.google.genai.types.SafetyRating.Builder

project() - Method in class com.google.genai.Client

Returns the project ID for Vertex AI APIs.

project(String) - Method in class com.google.genai.Client.Builder

Sets the project ID for Vertex AI APIs.

prompt() - Method in class com.google.genai.types.GenerateImagesParameters

Text prompt that typically describes the images to output.

prompt(String) - Method in class com.google.genai.types.GenerateImagesParameters.Builder

promptFeedback() - Method in class com.google.genai.types.GenerateContentResponse

Output only.

promptFeedback(GenerateContentResponsePromptFeedback) - Method in class com.google.genai.types.GenerateContentResponse.Builder

promptTokenCount() - Method in class com.google.genai.types.GenerateContentResponseUsageMetadata

Number of tokens in the request.

promptTokenCount(Integer) - Method in class com.google.genai.types.GenerateContentResponseUsageMetadata.Builder

properties() - Method in class com.google.genai.types.Schema

Optional.

properties(Map<String, Schema>) - Method in class com.google.genai.types.Schema.Builder

propertyOrdering() - Method in class com.google.genai.types.Schema

Optional.

propertyOrdering(List<String>) - Method in class com.google.genai.types.Schema.Builder

publicationDate() - Method in class com.google.genai.types.Citation

Output only.

publicationDate(GoogleTypeDate) - Method in class com.google.genai.types.Citation.Builder

R

ragCorpora() - Method in class com.google.genai.types.VertexRagStore

Optional.

ragCorpora(List<String>) - Method in class com.google.genai.types.VertexRagStore.Builder

ragCorpus() - Method in class com.google.genai.types.VertexRagStoreRagResource

Optional.

ragCorpus(String) - Method in class com.google.genai.types.VertexRagStoreRagResource.Builder

ragFileIds() - Method in class com.google.genai.types.VertexRagStoreRagResource

Optional. rag_file_id.

ragFileIds(List<String>) - Method in class com.google.genai.types.VertexRagStoreRagResource.Builder

ragResources() - Method in class com.google.genai.types.VertexRagStore

Optional.

ragResources(List<VertexRagStoreRagResource>) - Method in class com.google.genai.types.VertexRagStore.Builder

raiFilteredReason() - Method in class com.google.genai.types.GeneratedImage

Responsible AI filter reason if the image is filtered out of the response.

raiFilteredReason(String) - Method in class com.google.genai.types.GeneratedImage.Builder

RawReferenceImage - Class in com.google.genai.types

A raw reference image.

RawReferenceImage() - Constructor for class com.google.genai.types.RawReferenceImage

RawReferenceImage.Builder - Class in com.google.genai.types

Builder for RawReferenceImage.

referenceId() - Method in class com.google.genai.types.ControlReferenceImage

The id of the reference image.

referenceId() - Method in class com.google.genai.types.MaskReferenceImage

The id of the reference image.

referenceId() - Method in class com.google.genai.types.RawReferenceImage

The id of the reference image.

referenceId() - Method in class com.google.genai.types.StyleReferenceImage

The id of the reference image.

referenceId() - Method in class com.google.genai.types.SubjectReferenceImage

The id of the reference image.

referenceId(Integer) - Method in class com.google.genai.types.ControlReferenceImage.Builder

referenceId(Integer) - Method in class com.google.genai.types.MaskReferenceImage.Builder

referenceId(Integer) - Method in class com.google.genai.types.RawReferenceImage.Builder

referenceId(Integer) - Method in class com.google.genai.types.StyleReferenceImage.Builder

referenceId(Integer) - Method in class com.google.genai.types.SubjectReferenceImage.Builder

referenceImage() - Method in class com.google.genai.types.ControlReferenceImage

The reference image for the editing operation.

referenceImage() - Method in class com.google.genai.types.MaskReferenceImage

The reference image for the editing operation.

referenceImage() - Method in class com.google.genai.types.RawReferenceImage

The reference image for the editing operation.

referenceImage() - Method in class com.google.genai.types.StyleReferenceImage

The reference image for the editing operation.

referenceImage() - Method in class com.google.genai.types.SubjectReferenceImage

The reference image for the editing operation.

referenceImage(Image) - Method in class com.google.genai.types.ControlReferenceImage.Builder

referenceImage(Image) - Method in class com.google.genai.types.MaskReferenceImage.Builder

referenceImage(Image) - Method in class com.google.genai.types.RawReferenceImage.Builder

referenceImage(Image) - Method in class com.google.genai.types.StyleReferenceImage.Builder

referenceImage(Image) - Method in class com.google.genai.types.SubjectReferenceImage.Builder

referenceType() - Method in class com.google.genai.types.ControlReferenceImage

The type of the reference image.

referenceType() - Method in class com.google.genai.types.MaskReferenceImage

The type of the reference image.

referenceType() - Method in class com.google.genai.types.RawReferenceImage

The type of the reference image.

referenceType() - Method in class com.google.genai.types.StyleReferenceImage

The type of the reference image.

referenceType() - Method in class com.google.genai.types.SubjectReferenceImage

The type of the reference image.

referenceType(String) - Method in class com.google.genai.types.ControlReferenceImage.Builder

referenceType(String) - Method in class com.google.genai.types.MaskReferenceImage.Builder

referenceType(String) - Method in class com.google.genai.types.RawReferenceImage.Builder

referenceType(String) - Method in class com.google.genai.types.StyleReferenceImage.Builder

referenceType(String) - Method in class com.google.genai.types.SubjectReferenceImage.Builder

renderedContent() - Method in class com.google.genai.types.SearchEntryPoint

Optional.

renderedContent(String) - Method in class com.google.genai.types.SearchEntryPoint.Builder

ReplayFile - Class in com.google.genai.types

Represents a recorded session.

ReplayFile() - Constructor for class com.google.genai.types.ReplayFile

ReplayFile.Builder - Class in com.google.genai.types

Builder for ReplayFile.

replayId() - Method in class com.google.genai.types.ReplayFile

replayId(String) - Method in class com.google.genai.types.ReplayFile.Builder

ReplayInteraction - Class in com.google.genai.types

Represents a single interaction, request and response in a replay.

ReplayInteraction() - Constructor for class com.google.genai.types.ReplayInteraction

ReplayInteraction.Builder - Class in com.google.genai.types

Builder for ReplayInteraction.

ReplayRequest - Class in com.google.genai.types

Represents a single request in a replay.

ReplayRequest() - Constructor for class com.google.genai.types.ReplayRequest

ReplayRequest.Builder - Class in com.google.genai.types

Builder for ReplayRequest.

ReplayResponse - Class in com.google.genai.types

Represents a single response in a replay.

ReplayResponse() - Constructor for class com.google.genai.types.ReplayResponse

ReplayResponse.Builder - Class in com.google.genai.types

Builder for ReplayResponse.

request() - Method in class com.google.genai.types.ReplayInteraction

request(ReplayRequest) - Method in class com.google.genai.types.ReplayInteraction.Builder

required() - Method in class com.google.genai.types.Schema

Optional.

required(List<String>) - Method in class com.google.genai.types.Schema.Builder

response() - Method in class com.google.genai.types.FunctionDeclaration

Describes the output from the function in the OpenAPI JSON Schema Object format.

response() - Method in class com.google.genai.types.FunctionResponse

Required.

response() - Method in class com.google.genai.types.ReplayInteraction

response(ReplayResponse) - Method in class com.google.genai.types.ReplayInteraction.Builder

response(Schema) - Method in class com.google.genai.types.FunctionDeclaration.Builder

response(Map<String, Object>) - Method in class com.google.genai.types.FunctionResponse.Builder

responseLogprobs() - Method in class com.google.genai.types.GenerateContentConfig

Whether to return the log probabilities of the tokens that were chosen by the model at each step.

responseLogprobs() - Method in class com.google.genai.types.GenerationConfig

Optional.

responseLogprobs(boolean) - Method in class com.google.genai.types.GenerateContentConfig.Builder

responseLogprobs(boolean) - Method in class com.google.genai.types.GenerationConfig.Builder

responseMimeType() - Method in class com.google.genai.types.GenerateContentConfig

Output response media type of the generated candidate text.

responseMimeType() - Method in class com.google.genai.types.GenerationConfig

Optional.

responseMimeType(String) - Method in class com.google.genai.types.GenerateContentConfig.Builder

responseMimeType(String) - Method in class com.google.genai.types.GenerationConfig.Builder

responseModalities() - Method in class com.google.genai.types.GenerateContentConfig

The requested modalities of the response.

responseModalities(List<String>) - Method in class com.google.genai.types.GenerateContentConfig.Builder

responseSchema() - Method in class com.google.genai.types.GenerateContentConfig

Schema that the generated candidate text must adhere to.

responseSchema() - Method in class com.google.genai.types.GenerationConfig

Optional.

responseSchema(Schema) - Method in class com.google.genai.types.GenerateContentConfig.Builder

responseSchema(Schema) - Method in class com.google.genai.types.GenerationConfig.Builder

ResponseStream<T extends JsonSerializable> - Class in com.google.genai

An iterable of datatype objects.

ResponseStream(Class<T>, ApiResponse, Object, String) - Constructor for class com.google.genai.ResponseStream

retrieval() - Method in class com.google.genai.types.Tool

Optional.

retrieval(Retrieval) - Method in class com.google.genai.types.Tool.Builder

Retrieval - Class in com.google.genai.types

Defines a retrieval tool that model can call to access external knowledge.

Retrieval() - Constructor for class com.google.genai.types.Retrieval

Retrieval.Builder - Class in com.google.genai.types

Builder for Retrieval.

retrievalMetadata() - Method in class com.google.genai.types.GroundingMetadata

Optional.

retrievalMetadata(RetrievalMetadata) - Method in class com.google.genai.types.GroundingMetadata.Builder

RetrievalMetadata - Class in com.google.genai.types

Metadata related to retrieval in the grounding flow.

RetrievalMetadata() - Constructor for class com.google.genai.types.RetrievalMetadata

RetrievalMetadata.Builder - Class in com.google.genai.types

Builder for RetrievalMetadata.

retrievalQueries() - Method in class com.google.genai.types.GroundingMetadata

Optional.

retrievalQueries(List<String>) - Method in class com.google.genai.types.GroundingMetadata.Builder

retrievedContext() - Method in class com.google.genai.types.GroundingChunk

Grounding chunk from context retrieved by the retrieval tools.

retrievedContext(GroundingChunkRetrievedContext) - Method in class com.google.genai.types.GroundingChunk.Builder

role() - Method in class com.google.genai.types.Content

Optional.

role(String) - Method in class com.google.genai.types.Content.Builder

routingConfig() - Method in class com.google.genai.types.GenerateContentConfig

Configuration for model router requests.

routingConfig() - Method in class com.google.genai.types.GenerationConfig

Optional.

routingConfig(GenerationConfigRoutingConfig) - Method in class com.google.genai.types.GenerateContentConfig.Builder

routingConfig(GenerationConfigRoutingConfig) - Method in class com.google.genai.types.GenerationConfig.Builder

S

safetyFilterLevel() - Method in class com.google.genai.types.GenerateImagesConfig

Filter level for safety filtering.

safetyFilterLevel(String) - Method in class com.google.genai.types.GenerateImagesConfig.Builder

SafetyRating - Class in com.google.genai.types

Safety rating corresponding to the generated content.

SafetyRating() - Constructor for class com.google.genai.types.SafetyRating

SafetyRating.Builder - Class in com.google.genai.types

Builder for SafetyRating.

safetyRatings() - Method in class com.google.genai.types.Candidate

Output only.

safetyRatings() - Method in class com.google.genai.types.GenerateContentResponsePromptFeedback

Output only.

safetyRatings(List<SafetyRating>) - Method in class com.google.genai.types.Candidate.Builder

safetyRatings(List<SafetyRating>) - Method in class com.google.genai.types.GenerateContentResponsePromptFeedback.Builder

SafetySetting - Class in com.google.genai.types

Safety settings.

SafetySetting() - Constructor for class com.google.genai.types.SafetySetting

SafetySetting.Builder - Class in com.google.genai.types

Builder for SafetySetting.

safetySettings() - Method in class com.google.genai.types.GenerateContentConfig

Safety settings in the request to block unsafe content in the response.

safetySettings(List<SafetySetting>) - Method in class com.google.genai.types.GenerateContentConfig.Builder

Schema - Class in com.google.genai.types

Schema that defines the format of input and output data.

Schema() - Constructor for class com.google.genai.types.Schema

Schema.Builder - Class in com.google.genai.types

Builder for Schema.

sdkBlob() - Method in class com.google.genai.types.SearchEntryPoint

Optional.

sdkBlob(String) - Method in class com.google.genai.types.SearchEntryPoint.Builder

sdkResponseSegments() - Method in class com.google.genai.types.ReplayResponse

sdkResponseSegments(List<Map<String, Object>>) - Method in class com.google.genai.types.ReplayResponse.Builder

searchEntryPoint() - Method in class com.google.genai.types.GroundingMetadata

Optional.

searchEntryPoint(SearchEntryPoint) - Method in class com.google.genai.types.GroundingMetadata.Builder

SearchEntryPoint - Class in com.google.genai.types

Google search entry point.

SearchEntryPoint() - Constructor for class com.google.genai.types.SearchEntryPoint

SearchEntryPoint.Builder - Class in com.google.genai.types

Builder for SearchEntryPoint.

seed() - Method in class com.google.genai.types.GenerateContentConfig

When ``seed`` is fixed to a specific number, the model makes a best effort to provide the same response for repeated requests.

seed() - Method in class com.google.genai.types.GenerateImagesConfig

Random seed for image generation.

seed() - Method in class com.google.genai.types.GenerationConfig

Optional.

seed(Integer) - Method in class com.google.genai.types.GenerateContentConfig.Builder

seed(Integer) - Method in class com.google.genai.types.GenerateImagesConfig.Builder

seed(Integer) - Method in class com.google.genai.types.GenerationConfig.Builder

segment() - Method in class com.google.genai.types.GroundingSupport

Segment of the content this support belongs to.

segment(Segment) - Method in class com.google.genai.types.GroundingSupport.Builder

Segment - Class in com.google.genai.types

Segment of the content.

Segment() - Constructor for class com.google.genai.types.Segment

Segment.Builder - Class in com.google.genai.types

Builder for Segment.

segmentationClasses() - Method in class com.google.genai.types.MaskReferenceConfig

A list of up to 5 class ids to use for semantic segmentation.

segmentationClasses(List<Integer>) - Method in class com.google.genai.types.MaskReferenceConfig.Builder

setReplayId(String) - Method in class com.google.genai.Client

severity() - Method in class com.google.genai.types.SafetyRating

Output only.

severity(String) - Method in class com.google.genai.types.SafetyRating.Builder

severityScore() - Method in class com.google.genai.types.SafetyRating

Output only.

severityScore(Float) - Method in class com.google.genai.types.SafetyRating.Builder

similarityTopK() - Method in class com.google.genai.types.VertexRagStore

Optional.

similarityTopK(Integer) - Method in class com.google.genai.types.VertexRagStore.Builder

skipInApiMode() - Method in class com.google.genai.types.TestTableItem

When set to a reason string, this test will be skipped in the API mode.

skipInApiMode(String) - Method in class com.google.genai.types.TestTableItem.Builder

speechConfig() - Method in class com.google.genai.types.GenerateContentConfig

The speech generation configuration.

speechConfig(SpeechConfig) - Method in class com.google.genai.types.GenerateContentConfig.Builder

SpeechConfig - Class in com.google.genai.types

The speech generation configuration.

SpeechConfig() - Constructor for class com.google.genai.types.SpeechConfig

SpeechConfig.Builder - Class in com.google.genai.types

Builder for SpeechConfig.

startIndex() - Method in class com.google.genai.types.Citation

Output only.

startIndex() - Method in class com.google.genai.types.Segment

Output only.

startIndex(Integer) - Method in class com.google.genai.types.Citation.Builder

startIndex(Integer) - Method in class com.google.genai.types.Segment.Builder

startOffset() - Method in class com.google.genai.types.VideoMetadata

Optional.

startOffset(String) - Method in class com.google.genai.types.VideoMetadata.Builder

statusCode() - Method in class com.google.genai.types.ReplayResponse

statusCode(Integer) - Method in class com.google.genai.types.ReplayResponse.Builder

stopSequences() - Method in class com.google.genai.types.GenerateContentConfig

List of strings that tells the model to stop generating text if one of the strings is encountered in the response.

stopSequences() - Method in class com.google.genai.types.GenerationConfig

Optional.

stopSequences(List<String>) - Method in class com.google.genai.types.GenerateContentConfig.Builder

stopSequences(List<String>) - Method in class com.google.genai.types.GenerationConfig.Builder

styleDescription() - Method in class com.google.genai.types.StyleReferenceConfig

A text description of the style to use for the generated image.

styleDescription(String) - Method in class com.google.genai.types.StyleReferenceConfig.Builder

StyleReferenceConfig - Class in com.google.genai.types

Configuration for a Style reference image.

StyleReferenceConfig() - Constructor for class com.google.genai.types.StyleReferenceConfig

StyleReferenceConfig.Builder - Class in com.google.genai.types

Builder for StyleReferenceConfig.

StyleReferenceImage - Class in com.google.genai.types

A style reference image.

StyleReferenceImage() - Constructor for class com.google.genai.types.StyleReferenceImage

StyleReferenceImage.Builder - Class in com.google.genai.types

Builder for StyleReferenceImage.

subjectDescription() - Method in class com.google.genai.types.SubjectReferenceConfig

Subject description for the image.

subjectDescription(String) - Method in class com.google.genai.types.SubjectReferenceConfig.Builder

SubjectReferenceConfig - Class in com.google.genai.types

Configuration for a Subject reference image.

SubjectReferenceConfig() - Constructor for class com.google.genai.types.SubjectReferenceConfig

SubjectReferenceConfig.Builder - Class in com.google.genai.types

Builder for SubjectReferenceConfig.

SubjectReferenceImage - Class in com.google.genai.types

A subject reference image.

SubjectReferenceImage() - Constructor for class com.google.genai.types.SubjectReferenceImage

SubjectReferenceImage.Builder - Class in com.google.genai.types

Builder for SubjectReferenceImage.

subjectType() - Method in class com.google.genai.types.SubjectReferenceConfig

The subject type of a subject reference image.

subjectType(String) - Method in class com.google.genai.types.SubjectReferenceConfig.Builder

systemInstruction() - Method in class com.google.genai.types.GenerateContentConfig

Instructions for the model to steer it toward better performance.

systemInstruction(Content) - Method in class com.google.genai.types.GenerateContentConfig.Builder

T

temperature() - Method in class com.google.genai.types.GenerateContentConfig

Value that controls the degree of randomness in token selection.

temperature() - Method in class com.google.genai.types.GenerationConfig

Optional.

temperature(Float) - Method in class com.google.genai.types.GenerateContentConfig.Builder

temperature(Float) - Method in class com.google.genai.types.GenerationConfig.Builder

testMethod() - Method in class com.google.genai.types.TestTableFile

testMethod(String) - Method in class com.google.genai.types.TestTableFile.Builder

testTable() - Method in class com.google.genai.types.TestTableFile

testTable(List<TestTableItem>) - Method in class com.google.genai.types.TestTableFile.Builder

TestTableFile - Class in com.google.genai.types

None

TestTableFile() - Constructor for class com.google.genai.types.TestTableFile

TestTableFile.Builder - Class in com.google.genai.types

Builder for TestTableFile.

TestTableItem - Class in com.google.genai.types

None

TestTableItem() - Constructor for class com.google.genai.types.TestTableItem

TestTableItem.Builder - Class in com.google.genai.types

Builder for TestTableItem.

text() - Method in class com.google.genai.types.GenerateContentResponse

Returns the concatenation of all text parts in the first candidate of the response.

text() - Method in class com.google.genai.types.GroundingChunkRetrievedContext

Text of the attribution.

text() - Method in class com.google.genai.types.Part

Optional.

text() - Method in class com.google.genai.types.Segment

Output only.

text(String) - Method in class com.google.genai.types.GroundingChunkRetrievedContext.Builder

text(String) - Method in class com.google.genai.types.Part.Builder

text(String) - Method in class com.google.genai.types.Segment.Builder

thinkingConfig() - Method in class com.google.genai.types.GenerateContentConfig

The thinking features configuration.

thinkingConfig(ThinkingConfig) - Method in class com.google.genai.types.GenerateContentConfig.Builder

ThinkingConfig - Class in com.google.genai.types

The thinking features configuration.

ThinkingConfig() - Constructor for class com.google.genai.types.ThinkingConfig

ThinkingConfig.Builder - Class in com.google.genai.types

Builder for ThinkingConfig.

thought() - Method in class com.google.genai.types.Part

Indicates if the part is thought from the model.

thought(boolean) - Method in class com.google.genai.types.Part.Builder

threshold() - Method in class com.google.genai.types.SafetySetting

Required.

threshold(String) - Method in class com.google.genai.types.SafetySetting.Builder

timeout() - Method in class com.google.genai.types.HttpOptions

Timeout for the request in milliseconds.

timeout(Integer) - Method in class com.google.genai.types.HttpOptions.Builder

title() - Method in class com.google.genai.types.Citation

Output only.

title() - Method in class com.google.genai.types.GroundingChunkRetrievedContext

Title of the attribution.

title() - Method in class com.google.genai.types.GroundingChunkWeb

Title of the chunk.

title() - Method in class com.google.genai.types.Schema

Optional.

title(String) - Method in class com.google.genai.types.Citation.Builder

title(String) - Method in class com.google.genai.types.GroundingChunkRetrievedContext.Builder

title(String) - Method in class com.google.genai.types.GroundingChunkWeb.Builder

title(String) - Method in class com.google.genai.types.Schema.Builder

toBuilder() - Method in class com.google.genai.types.Blob

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.Candidate

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.Citation

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.CitationMetadata

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.CodeExecutionResult

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.Content

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.ControlReferenceConfig

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.ControlReferenceImage

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.DynamicRetrievalConfig

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.ExecutableCode

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.FileData

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.FunctionCall

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.FunctionCallingConfig

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.FunctionDeclaration

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.FunctionResponse

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.GenerateContentConfig

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.GenerateContentParameters

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.GenerateContentResponse

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.GenerateContentResponsePromptFeedback

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.GenerateContentResponseUsageMetadata

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.GeneratedImage

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.GenerateImagesConfig

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.GenerateImagesParameters

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.GenerateImagesResponse

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.GenerationConfig

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.GenerationConfigRoutingConfig

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.GenerationConfigRoutingConfigAutoRoutingMode

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.GenerationConfigRoutingConfigManualRoutingMode

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.GoogleSearch

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.GoogleSearchRetrieval

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.GoogleTypeDate

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.GroundingChunk

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.GroundingChunkRetrievedContext

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.GroundingChunkWeb

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.GroundingMetadata

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.GroundingSupport

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.HttpOptions

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.Image

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.LogprobsResult

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.LogprobsResultCandidate

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.LogprobsResultTopCandidates

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.MaskReferenceConfig

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.MaskReferenceImage

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.Part

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.PrebuiltVoiceConfig

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.RawReferenceImage

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.ReplayFile

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.ReplayInteraction

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.ReplayRequest

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.ReplayResponse

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.Retrieval

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.RetrievalMetadata

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.SafetyRating

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.SafetySetting

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.Schema

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.SearchEntryPoint

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.Segment

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.SpeechConfig

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.StyleReferenceConfig

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.StyleReferenceImage

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.SubjectReferenceConfig

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.SubjectReferenceImage

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.TestTableFile

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.TestTableItem

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.ThinkingConfig

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.Tool

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.ToolCodeExecution

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.ToolConfig

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.UploadFileConfig

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.UpscaleImageAPIConfig

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.UpscaleImageAPIParameters

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.UpscaleImageConfig

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.UpscaleImageParameters

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.UpscaleImageResponse

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.VertexAISearch

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.VertexRagStore

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.VertexRagStoreRagResource

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.VideoMetadata

Creates a builder with the same values as this instance.

toBuilder() - Method in class com.google.genai.types.VoiceConfig

Creates a builder with the same values as this instance.

toJson() - Method in class com.google.genai.JsonSerializable

Serializes the instance to a Json string.

toJsonNode(Object) - Static method in class com.google.genai.JsonSerializable

Serializes an object to a JsonNode.

toJsonString(Object) - Static method in class com.google.genai.JsonSerializable

Serializes an object to a Json string.

token() - Method in class com.google.genai.types.LogprobsResultCandidate

The candidate's token string value.

token(String) - Method in class com.google.genai.types.LogprobsResultCandidate.Builder

tokenCount() - Method in class com.google.genai.types.Candidate

Number of tokens for this candidate.

tokenCount(Integer) - Method in class com.google.genai.types.Candidate.Builder

tokenId() - Method in class com.google.genai.types.LogprobsResultCandidate

The candidate's token id value.

tokenId(Integer) - Method in class com.google.genai.types.LogprobsResultCandidate.Builder

Tool - Class in com.google.genai.types

Tool details of a tool that the model may use to generate a response.

Tool() - Constructor for class com.google.genai.types.Tool

Tool.Builder - Class in com.google.genai.types

Builder for Tool.

ToolCodeExecution - Class in com.google.genai.types

Tool that executes code generated by the model, and automatically returns the result to the model.

ToolCodeExecution() - Constructor for class com.google.genai.types.ToolCodeExecution

ToolCodeExecution.Builder - Class in com.google.genai.types

Builder for ToolCodeExecution.

toolConfig() - Method in class com.google.genai.types.GenerateContentConfig

Associates model output to a specific function call.

toolConfig(ToolConfig) - Method in class com.google.genai.types.GenerateContentConfig.Builder

ToolConfig - Class in com.google.genai.types

Tool config.

ToolConfig() - Constructor for class com.google.genai.types.ToolConfig

ToolConfig.Builder - Class in com.google.genai.types

Builder for ToolConfig.

tools() - Method in class com.google.genai.types.GenerateContentConfig

Code that enables the system to interact with external systems to perform an action outside of the knowledge and scope of the model.

tools(List<Tool>) - Method in class com.google.genai.types.GenerateContentConfig.Builder

topCandidates() - Method in class com.google.genai.types.LogprobsResult

Length = total number of decoding steps.

topCandidates(List<LogprobsResultTopCandidates>) - Method in class com.google.genai.types.LogprobsResult.Builder

topK() - Method in class com.google.genai.types.GenerateContentConfig

For each token selection step, the ``top_k`` tokens with the highest probabilities are sampled.

topK() - Method in class com.google.genai.types.GenerationConfig

Optional.

topK(Float) - Method in class com.google.genai.types.GenerateContentConfig.Builder

topK(Float) - Method in class com.google.genai.types.GenerationConfig.Builder

topP() - Method in class com.google.genai.types.GenerateContentConfig

Tokens are selected from the most to least probable until the sum of their probabilities equals this value.

topP() - Method in class com.google.genai.types.GenerationConfig

Optional.

topP(Float) - Method in class com.google.genai.types.GenerateContentConfig.Builder

topP(Float) - Method in class com.google.genai.types.GenerationConfig.Builder

totalTokenCount() - Method in class com.google.genai.types.GenerateContentResponseUsageMetadata

Total token count for prompt and response candidates.

totalTokenCount(Integer) - Method in class com.google.genai.types.GenerateContentResponseUsageMetadata.Builder

type() - Method in class com.google.genai.types.Schema

Optional.

type(String) - Method in class com.google.genai.types.Schema.Builder

U

UploadFileConfig - Class in com.google.genai.types

Used to override the default configuration.

UploadFileConfig() - Constructor for class com.google.genai.types.UploadFileConfig

UploadFileConfig.Builder - Class in com.google.genai.types

Builder for UploadFileConfig.

upscaleFactor() - Method in class com.google.genai.types.UpscaleImageAPIParameters

The factor to upscale the image (x2 or x4).

upscaleFactor() - Method in class com.google.genai.types.UpscaleImageParameters

The factor to upscale the image (x2 or x4).

upscaleFactor(String) - Method in class com.google.genai.types.UpscaleImageAPIParameters.Builder

upscaleFactor(String) - Method in class com.google.genai.types.UpscaleImageParameters.Builder

upscaleImage(String, Image, String, UpscaleImageConfig) - Method in class com.google.genai.AsyncModels

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

upscaleImage(String, Image, String, UpscaleImageConfig) - Method in class com.google.genai.Models

Upscales an image given a GenAI model and an image and an upscale factor.

UpscaleImageAPIConfig - Class in com.google.genai.types

API config for UpscaleImage with fields not exposed to users.

UpscaleImageAPIConfig() - Constructor for class com.google.genai.types.UpscaleImageAPIConfig

UpscaleImageAPIConfig.Builder - Class in com.google.genai.types

Builder for UpscaleImageAPIConfig.

UpscaleImageAPIParameters - Class in com.google.genai.types

API parameters for UpscaleImage.

UpscaleImageAPIParameters() - Constructor for class com.google.genai.types.UpscaleImageAPIParameters

UpscaleImageAPIParameters.Builder - Class in com.google.genai.types

Builder for UpscaleImageAPIParameters.

UpscaleImageConfig - Class in com.google.genai.types

Configuration for upscaling an image.

UpscaleImageConfig() - Constructor for class com.google.genai.types.UpscaleImageConfig

UpscaleImageConfig.Builder - Class in com.google.genai.types

Builder for UpscaleImageConfig.

UpscaleImageParameters - Class in com.google.genai.types

User-facing config UpscaleImageParameters.

UpscaleImageParameters() - Constructor for class com.google.genai.types.UpscaleImageParameters

UpscaleImageParameters.Builder - Class in com.google.genai.types

Builder for UpscaleImageParameters.

UpscaleImageResponse - Class in com.google.genai.types

None

UpscaleImageResponse() - Constructor for class com.google.genai.types.UpscaleImageResponse

UpscaleImageResponse.Builder - Class in com.google.genai.types

Builder for UpscaleImageResponse.

uri() - Method in class com.google.genai.types.Citation

Output only.

uri() - Method in class com.google.genai.types.GroundingChunkRetrievedContext

URI reference of the attribution.

uri() - Method in class com.google.genai.types.GroundingChunkWeb

URI reference of the chunk.

uri(String) - Method in class com.google.genai.types.Citation.Builder

uri(String) - Method in class com.google.genai.types.GroundingChunkRetrievedContext.Builder

uri(String) - Method in class com.google.genai.types.GroundingChunkWeb.Builder

url() - Method in class com.google.genai.types.ReplayRequest

url(String) - Method in class com.google.genai.types.ReplayRequest.Builder

usageMetadata() - Method in class com.google.genai.types.GenerateContentResponse

Usage metadata about the response(s).

usageMetadata(GenerateContentResponseUsageMetadata) - Method in class com.google.genai.types.GenerateContentResponse.Builder

V

vectorDistanceThreshold() - Method in class com.google.genai.types.VertexRagStore

Optional.

vectorDistanceThreshold(Double) - Method in class com.google.genai.types.VertexRagStore.Builder

vertexAI(boolean) - Method in class com.google.genai.Client.Builder

Sets whether to use Vertex AI APIs.

vertexAiSearch() - Method in class com.google.genai.types.Retrieval

Set to use data source powered by Vertex AI Search.

vertexAiSearch(VertexAISearch) - Method in class com.google.genai.types.Retrieval.Builder

VertexAISearch - Class in com.google.genai.types

Retrieve from Vertex AI Search datastore for grounding.

VertexAISearch() - Constructor for class com.google.genai.types.VertexAISearch

VertexAISearch.Builder - Class in com.google.genai.types

Builder for VertexAISearch.

vertexRagStore() - Method in class com.google.genai.types.Retrieval

Set to use data source powered by Vertex RAG store.

vertexRagStore(VertexRagStore) - Method in class com.google.genai.types.Retrieval.Builder

VertexRagStore - Class in com.google.genai.types

Retrieve from Vertex RAG Store for grounding.

VertexRagStore() - Constructor for class com.google.genai.types.VertexRagStore

VertexRagStore.Builder - Class in com.google.genai.types

Builder for VertexRagStore.

VertexRagStoreRagResource - Class in com.google.genai.types

The definition of the Rag resource.

VertexRagStoreRagResource() - Constructor for class com.google.genai.types.VertexRagStoreRagResource

VertexRagStoreRagResource.Builder - Class in com.google.genai.types

Builder for VertexRagStoreRagResource.

videoMetadata() - Method in class com.google.genai.types.Part

Metadata for a given video.

videoMetadata(VideoMetadata) - Method in class com.google.genai.types.Part.Builder

VideoMetadata - Class in com.google.genai.types

Metadata describes the input video content.

VideoMetadata() - Constructor for class com.google.genai.types.VideoMetadata

VideoMetadata.Builder - Class in com.google.genai.types

Builder for VideoMetadata.

voiceConfig() - Method in class com.google.genai.types.SpeechConfig

The configuration for the speaker to use.

voiceConfig(VoiceConfig) - Method in class com.google.genai.types.SpeechConfig.Builder

VoiceConfig - Class in com.google.genai.types

The configuration for the voice to use.

VoiceConfig() - Constructor for class com.google.genai.types.VoiceConfig

VoiceConfig.Builder - Class in com.google.genai.types

Builder for VoiceConfig.

voiceName() - Method in class com.google.genai.types.PrebuiltVoiceConfig

The name of the prebuilt voice to use.

voiceName(String) - Method in class com.google.genai.types.PrebuiltVoiceConfig.Builder

W

web() - Method in class com.google.genai.types.GroundingChunk

Grounding chunk from the web.

web(GroundingChunkWeb) - Method in class com.google.genai.types.GroundingChunk.Builder

webSearchQueries() - Method in class com.google.genai.types.GroundingMetadata

Optional.

webSearchQueries(List<String>) - Method in class com.google.genai.types.GroundingMetadata.Builder

Y

year() - Method in class com.google.genai.types.GoogleTypeDate

Year of the date.

year(Integer) - Method in class com.google.genai.types.GoogleTypeDate.Builder

A B C D E F G H I J L M N O P R S T U V W Y
All Classes and Interfaces|All Packages