A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  Y  Z 

R

ragChunk() - function in com.google.genai.types.GroundingChunkRetrievedContext
Additional context for a Retrieval-Augmented Generation (RAG) retrieval result.
ragChunk(com.google.genai.types.RagChunk) - function in com.google.genai.types.GroundingChunkRetrievedContext.Builder
Setter for ragChunk.
ragChunk(com.google.genai.types.RagChunk.Builder) - function in com.google.genai.types.GroundingChunkRetrievedContext.Builder
Setter for ragChunk builder.
RagChunk - class in com.google.genai.types
A RagChunk includes the content of a chunk of a RagFile, and associated metadata.
RagChunk.Builder - class in com.google.genai.types.RagChunk
Builder for RagChunk.
RagChunkPageSpan - class in com.google.genai.types
Represents where the chunk starts and ends in the document.
RagChunkPageSpan.Builder - class in com.google.genai.types.RagChunkPageSpan
Builder for RagChunkPageSpan.
ragCorpora() - function in com.google.genai.types.VertexRagStore
Optional.
ragCorpora(kotlin.Array) - function in com.google.genai.types.VertexRagStore.Builder
Setter for ragCorpora.
ragCorpora(java.util.List) - function in com.google.genai.types.VertexRagStore.Builder
Setter for ragCorpora.
ragCorpus() - function in com.google.genai.types.VertexRagStoreRagResource
Optional.
ragCorpus(java.lang.String) - function in com.google.genai.types.VertexRagStoreRagResource.Builder
Setter for ragCorpus.
ragFileIds() - function in com.google.genai.types.VertexRagStoreRagResource
Optional.
ragFileIds(kotlin.Array) - function in com.google.genai.types.VertexRagStoreRagResource.Builder
Setter for ragFileIds.
ragFileIds(java.util.List) - function in com.google.genai.types.VertexRagStoreRagResource.Builder
Setter for ragFileIds.
ragResources() - function in com.google.genai.types.VertexRagStore
Optional.
ragResources(kotlin.Array) - function in com.google.genai.types.VertexRagStore.Builder
Setter for ragResources.
ragResources(kotlin.Array) - function in com.google.genai.types.VertexRagStore.Builder
Setter for ragResources builder.
ragResources(java.util.List) - function in com.google.genai.types.VertexRagStore.Builder
Setter for ragResources.
RagRetrievalConfig - class in com.google.genai.types
Specifies the context retrieval config.
ragRetrievalConfig() - function in com.google.genai.types.VertexRagStore
Optional.
ragRetrievalConfig(com.google.genai.types.RagRetrievalConfig) - function in com.google.genai.types.VertexRagStore.Builder
Setter for ragRetrievalConfig.
ragRetrievalConfig(com.google.genai.types.RagRetrievalConfig.Builder) - function in com.google.genai.types.VertexRagStore.Builder
Setter for ragRetrievalConfig builder.
RagRetrievalConfig.Builder - class in com.google.genai.types.RagRetrievalConfig
Builder for RagRetrievalConfig.
RagRetrievalConfigFilter - class in com.google.genai.types
Config for filters.
RagRetrievalConfigFilter.Builder - class in com.google.genai.types.RagRetrievalConfigFilter
Builder for RagRetrievalConfigFilter.
RagRetrievalConfigHybridSearch - class in com.google.genai.types
Config for Hybrid Search.
RagRetrievalConfigHybridSearch.Builder - class in com.google.genai.types.RagRetrievalConfigHybridSearch
Builder for RagRetrievalConfigHybridSearch.
RagRetrievalConfigRanking - class in com.google.genai.types
Config for ranking and reranking.
RagRetrievalConfigRanking.Builder - class in com.google.genai.types.RagRetrievalConfigRanking
Builder for RagRetrievalConfigRanking.
RagRetrievalConfigRankingLlmRanker - class in com.google.genai.types
Config for LlmRanker.
RagRetrievalConfigRankingLlmRanker.Builder - class in com.google.genai.types.RagRetrievalConfigRankingLlmRanker
Builder for RagRetrievalConfigRankingLlmRanker.
RagRetrievalConfigRankingRankService - class in com.google.genai.types
Config for Rank Service.
RagRetrievalConfigRankingRankService.Builder - class in com.google.genai.types.RagRetrievalConfigRankingRankService
Builder for RagRetrievalConfigRankingRankService.
raiFilteredReason() - function in com.google.genai.types.GeneratedImage
Responsible AI filter reason if the image is filtered out of the response.
raiFilteredReason(java.lang.String) - function in com.google.genai.types.GeneratedImage.Builder
Setter for raiFilteredReason.
raiMediaFilteredCount() - function in com.google.genai.types.GenerateVideosResponse
Returns if any videos were filtered due to RAI policies.
raiMediaFilteredCount(java.lang.Integer) - function in com.google.genai.types.GenerateVideosResponse.Builder
Setter for raiMediaFilteredCount.
raiMediaFilteredReasons() - function in com.google.genai.types.GenerateVideosResponse
Returns rai failure reasons if any.
raiMediaFilteredReasons(kotlin.Array) - function in com.google.genai.types.GenerateVideosResponse.Builder
Setter for raiMediaFilteredReasons.
raiMediaFilteredReasons(java.util.List) - function in com.google.genai.types.GenerateVideosResponse.Builder
Setter for raiMediaFilteredReasons.
ranking() - function in com.google.genai.types.RagRetrievalConfig
Optional.
ranking(com.google.genai.types.RagRetrievalConfigRanking) - function in com.google.genai.types.RagRetrievalConfig.Builder
Setter for ranking.
ranking(com.google.genai.types.RagRetrievalConfigRanking.Builder) - function in com.google.genai.types.RagRetrievalConfig.Builder
Setter for ranking builder.
rankService() - function in com.google.genai.types.RagRetrievalConfigRanking
Optional.
rankService(com.google.genai.types.RagRetrievalConfigRankingRankService) - function in com.google.genai.types.RagRetrievalConfigRanking.Builder
Setter for rankService.
rankService(com.google.genai.types.RagRetrievalConfigRankingRankService.Builder) - function in com.google.genai.types.RagRetrievalConfigRanking.Builder
Setter for rankService builder.
RawOutput - class in com.google.genai.types
Raw output.
rawOutput() - function in com.google.genai.types.RawOutput
Output only.
rawOutput(kotlin.Array) - function in com.google.genai.types.RawOutput.Builder
Setter for rawOutput.
rawOutput(java.util.List) - function in com.google.genai.types.RawOutput.Builder
Setter for rawOutput.
RawOutput.Builder - class in com.google.genai.types.RawOutput
Builder for RawOutput.
rawOutputs() - function in com.google.genai.types.CustomOutput
Output only.
rawOutputs(com.google.genai.types.RawOutput) - function in com.google.genai.types.CustomOutput.Builder
Setter for rawOutputs.
rawOutputs(com.google.genai.types.RawOutput.Builder) - function in com.google.genai.types.CustomOutput.Builder
Setter for rawOutputs builder.
RawReferenceImage - class in com.google.genai.types
A raw reference image.
RawReferenceImage.Builder - class in com.google.genai.types.RawReferenceImage
Builder for RawReferenceImage.
realtimeInput() - function in com.google.genai.types.LiveClientMessage
User input that is sent in real time.
realtimeInput(com.google.genai.types.LiveClientRealtimeInput) - function in com.google.genai.types.LiveClientMessage.Builder
Setter for realtimeInput.
realtimeInput(com.google.genai.types.LiveClientRealtimeInput.Builder) - function in com.google.genai.types.LiveClientMessage.Builder
Setter for realtimeInput builder.
realtimeInputConfig() - function in com.google.genai.types.LiveClientSetup
Configures the realtime input behavior in BidiGenerateContent.
realtimeInputConfig(com.google.genai.types.RealtimeInputConfig) - function in com.google.genai.types.LiveClientSetup.Builder
Setter for realtimeInputConfig.
realtimeInputConfig(com.google.genai.types.RealtimeInputConfig.Builder) - function in com.google.genai.types.LiveClientSetup.Builder
Setter for realtimeInputConfig builder.
realtimeInputConfig() - function in com.google.genai.types.LiveConnectConfig
Configures the realtime input behavior in BidiGenerateContent.
realtimeInputConfig(com.google.genai.types.RealtimeInputConfig) - function in com.google.genai.types.LiveConnectConfig.Builder
Setter for realtimeInputConfig.
realtimeInputConfig(com.google.genai.types.RealtimeInputConfig.Builder) - function in com.google.genai.types.LiveConnectConfig.Builder
Setter for realtimeInputConfig builder.
RealtimeInputConfig - class in com.google.genai.types
Marks the end of user activity.
RealtimeInputConfig.Builder - class in com.google.genai.types.RealtimeInputConfig
Builder for RealtimeInputConfig.
realtimeInputParameters() - function in com.google.genai.types.LiveClientMessage
This is an alias for `realtime_input` field.
realtimeInputParameters(com.google.genai.types.LiveSendRealtimeInputParameters) - function in com.google.genai.types.LiveClientMessage.Builder
Setter for realtimeInputParameters.
realtimeInputParameters(com.google.genai.types.LiveSendRealtimeInputParameters.Builder) - function in com.google.genai.types.LiveClientMessage.Builder
Setter for realtimeInputParameters builder.
receive(java.util.function.Consumer) - function in com.google.genai.AsyncSession
Registers a callback to receive messages from the live session.
RECITATION - enum entry in com.google.genai.types.FinishReason.Known

The token generation stopped because of potential recitation.

recontextImage(java.lang.String,com.google.genai.types.RecontextImageSource,com.google.genai.types.RecontextImageConfig) - function in com.google.genai.AsyncModels
Asynchronously recontextualizes an image.
recontextImage(java.lang.String,com.google.genai.types.RecontextImageSource,com.google.genai.types.RecontextImageConfig) - function in com.google.genai.Models
Recontextualizes an image.
RecontextImageConfig - class in com.google.genai.types
Configuration for recontextualizing an image.
RecontextImageConfig.Builder - class in com.google.genai.types.RecontextImageConfig
Builder for RecontextImageConfig.
RecontextImageParameters - class in com.google.genai.types
The parameters for recontextualizing an image.
RecontextImageParameters.Builder - class in com.google.genai.types.RecontextImageParameters
Builder for RecontextImageParameters.
RecontextImageResponse - class in com.google.genai.types
The output images response.
RecontextImageResponse.Builder - class in com.google.genai.types.RecontextImageResponse
Builder for RecontextImageResponse.
RecontextImageSource - class in com.google.genai.types
A set of source input(s) for image recontextualization.
RecontextImageSource.Builder - class in com.google.genai.types.RecontextImageSource
Builder for RecontextImageSource.
referenceId() - function in com.google.genai.types.ContentReferenceImage
The id of the reference image.
referenceId(java.lang.Integer) - function in com.google.genai.types.ContentReferenceImage.Builder
Setter for referenceId.
referenceId() - function in com.google.genai.types.ControlReferenceImage
The id of the reference image.
referenceId(java.lang.Integer) - function in com.google.genai.types.ControlReferenceImage.Builder
Setter for referenceId.
referenceId() - function in com.google.genai.types.MaskReferenceImage
The id of the reference image.
referenceId(java.lang.Integer) - function in com.google.genai.types.MaskReferenceImage.Builder
Setter for referenceId.
referenceId() - function in com.google.genai.types.RawReferenceImage
The id of the reference image.
referenceId(java.lang.Integer) - function in com.google.genai.types.RawReferenceImage.Builder
Setter for referenceId.
referenceId() - function in com.google.genai.types.ReferenceImageAPI
The id of the reference image.
referenceId(java.lang.Integer) - function in com.google.genai.types.ReferenceImageAPI.Builder
Setter for referenceId.
referenceId() - function in com.google.genai.types.StyleReferenceImage
The id of the reference image.
referenceId(java.lang.Integer) - function in com.google.genai.types.StyleReferenceImage.Builder
Setter for referenceId.
referenceId() - function in com.google.genai.types.SubjectReferenceImage
The id of the reference image.
referenceId(java.lang.Integer) - function in com.google.genai.types.SubjectReferenceImage.Builder
Setter for referenceId.
referenceImage() - function in com.google.genai.types.ContentReferenceImage
The reference image for the editing operation.
referenceImage(com.google.genai.types.Image) - function in com.google.genai.types.ContentReferenceImage.Builder
Setter for referenceImage.
referenceImage(com.google.genai.types.Image.Builder) - function in com.google.genai.types.ContentReferenceImage.Builder
Setter for referenceImage builder.
referenceImage() - function in com.google.genai.types.ControlReferenceImage
The reference image for the editing operation.
referenceImage(com.google.genai.types.Image) - function in com.google.genai.types.ControlReferenceImage.Builder
Setter for referenceImage.
referenceImage(com.google.genai.types.Image.Builder) - function in com.google.genai.types.ControlReferenceImage.Builder
Setter for referenceImage builder.
referenceImage() - function in com.google.genai.types.MaskReferenceImage
The reference image for the editing operation.
referenceImage(com.google.genai.types.Image) - function in com.google.genai.types.MaskReferenceImage.Builder
Setter for referenceImage.
referenceImage(com.google.genai.types.Image.Builder) - function in com.google.genai.types.MaskReferenceImage.Builder
Setter for referenceImage builder.
referenceImage() - function in com.google.genai.types.RawReferenceImage
The reference image for the editing operation.
referenceImage(com.google.genai.types.Image) - function in com.google.genai.types.RawReferenceImage.Builder
Setter for referenceImage.
referenceImage(com.google.genai.types.Image.Builder) - function in com.google.genai.types.RawReferenceImage.Builder
Setter for referenceImage builder.
ReferenceImage - class in com.google.genai.types
An interface for a Reference image.
referenceImage() - function in com.google.genai.types.ReferenceImageAPI
The reference image for the editing operation.
referenceImage(com.google.genai.types.Image) - function in com.google.genai.types.ReferenceImageAPI.Builder
Setter for referenceImage.
referenceImage(com.google.genai.types.Image.Builder) - function in com.google.genai.types.ReferenceImageAPI.Builder
Setter for referenceImage builder.
referenceImage() - function in com.google.genai.types.StyleReferenceImage
The reference image for the editing operation.
referenceImage(com.google.genai.types.Image) - function in com.google.genai.types.StyleReferenceImage.Builder
Setter for referenceImage.
referenceImage(com.google.genai.types.Image.Builder) - function in com.google.genai.types.StyleReferenceImage.Builder
Setter for referenceImage builder.
referenceImage() - function in com.google.genai.types.SubjectReferenceImage
The reference image for the editing operation.
referenceImage(com.google.genai.types.Image) - function in com.google.genai.types.SubjectReferenceImage.Builder
Setter for referenceImage.
referenceImage(com.google.genai.types.Image.Builder) - function in com.google.genai.types.SubjectReferenceImage.Builder
Setter for referenceImage builder.
ReferenceImageAPI - class in com.google.genai.types
Private class that represents a Reference image that is sent to API.
ReferenceImageAPI.Builder - class in com.google.genai.types.ReferenceImageAPI
Builder for ReferenceImageAPI.
referenceImages() - function in com.google.genai.types.EditImageParameters
The reference images for editing.
referenceImages(kotlin.Array) - function in com.google.genai.types.EditImageParameters.Builder
Setter for referenceImages.
referenceImages(java.util.List) - function in com.google.genai.types.EditImageParameters.Builder
Setter for referenceImages.
referenceImages() - function in com.google.genai.types.GenerateVideosConfig
The images to use as the references to generate the videos.
referenceImages(kotlin.Array) - function in com.google.genai.types.GenerateVideosConfig.Builder
Setter for referenceImages.
referenceImages(kotlin.Array) - function in com.google.genai.types.GenerateVideosConfig.Builder
Setter for referenceImages builder.
referenceImages(java.util.List) - function in com.google.genai.types.GenerateVideosConfig.Builder
Setter for referenceImages.
referenceType() - function in com.google.genai.types.ContentReferenceImage
The type of the reference image.
referenceType(java.lang.String) - function in com.google.genai.types.ContentReferenceImage.Builder
Setter for referenceType.
referenceType() - function in com.google.genai.types.ControlReferenceImage
The type of the reference image.
referenceType(java.lang.String) - function in com.google.genai.types.ControlReferenceImage.Builder
Setter for referenceType.
referenceType() - function in com.google.genai.types.MaskReferenceImage
The type of the reference image.
referenceType(java.lang.String) - function in com.google.genai.types.MaskReferenceImage.Builder
Setter for referenceType.
referenceType() - function in com.google.genai.types.RawReferenceImage
The type of the reference image.
referenceType(java.lang.String) - function in com.google.genai.types.RawReferenceImage.Builder
Setter for referenceType.
referenceType() - function in com.google.genai.types.ReferenceImageAPI
The type of the reference image.
referenceType(java.lang.String) - function in com.google.genai.types.ReferenceImageAPI.Builder
Setter for referenceType.
referenceType() - function in com.google.genai.types.StyleReferenceImage
The type of the reference image.
referenceType(java.lang.String) - function in com.google.genai.types.StyleReferenceImage.Builder
Setter for referenceType.
referenceType() - function in com.google.genai.types.SubjectReferenceImage
The type of the reference image.
referenceType(java.lang.String) - function in com.google.genai.types.SubjectReferenceImage.Builder
Setter for referenceType.
referenceType() - function in com.google.genai.types.VideoGenerationReferenceImage
The type of the reference image, which defines how the reference image will be used to generate the video.
referenceType(com.google.genai.types.VideoGenerationReferenceType) - function in com.google.genai.types.VideoGenerationReferenceImage.Builder
Setter for referenceType.
referenceType(com.google.genai.types.VideoGenerationReferenceType.Known) - function in com.google.genai.types.VideoGenerationReferenceImage.Builder
Setter for referenceType given a known enum.
referenceType(java.lang.String) - function in com.google.genai.types.VideoGenerationReferenceImage.Builder
Setter for referenceType given a string.
REGISTERED - enum entry in com.google.genai.types.FileSource.Known
 
registerFiles(com.google.auth.oauth2.GoogleCredentials,java.util.List,com.google.genai.types.RegisterFilesConfig) - function in com.google.genai.AsyncFiles
Asynchronously registers Google Cloud Storage files for use with the API.
registerFiles(com.google.auth.oauth2.GoogleCredentials,java.util.List,com.google.genai.types.RegisterFilesConfig) - function in com.google.genai.Files
Registers Google Cloud Storage files for use with the API.
RegisterFilesConfig - class in com.google.genai.types
Used to override the default configuration.
RegisterFilesConfig.Builder - class in com.google.genai.types.RegisterFilesConfig
Builder for RegisterFilesConfig.
RegisterFilesResponse - class in com.google.genai.types
Response for the _register file method.
RegisterFilesResponse.Builder - class in com.google.genai.types.RegisterFilesResponse
Builder for RegisterFilesResponse.
relativePublishTimeDescription() - function in com.google.genai.types.GroundingChunkMapsPlaceAnswerSourcesReviewSnippet
A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country.
relativePublishTimeDescription(java.lang.String) - function in com.google.genai.types.GroundingChunkMapsPlaceAnswerSourcesReviewSnippet.Builder
Setter for relativePublishTimeDescription.
REMOVE - enum entry in com.google.genai.types.VideoGenerationMaskMode.Known

The image mask is used to determine an object in the first video frame to track. This object is removed from the video.

REMOVE_STATIC - enum entry in com.google.genai.types.VideoGenerationMaskMode.Known

The image mask is used to determine a region in the video. Objects in this region will be removed.

renderedContent() - function in com.google.genai.types.SearchEntryPoint
Optional.
renderedContent(java.lang.String) - function in com.google.genai.types.SearchEntryPoint.Builder
Setter for renderedContent.
renderedParts() - function in com.google.genai.types.GroundingSupport
Indices into the `rendered_parts` field of the `GroundingMetadata` message.
renderedParts(kotlin.Array) - function in com.google.genai.types.GroundingSupport.Builder
Setter for renderedParts.
renderedParts(java.util.List) - function in com.google.genai.types.GroundingSupport.Builder
Setter for renderedParts.
ReplayApiClient - class in com.google.genai
Base client for the HTTP APIs.
ReplayApiResponse - class in com.google.genai
Provides a simulated HTTP response from a replay file.
ReplayFile - class in com.google.genai.types
Represents a recorded session.
ReplayFile.Builder - class in com.google.genai.types.ReplayFile
Builder for ReplayFile.
replayId() - function in com.google.genai.types.ReplayFile
 
replayId(java.lang.String) - function in com.google.genai.types.ReplayFile.Builder
Setter for replayId.
ReplayInteraction - class in com.google.genai.types
Represents a single interaction, request and response in a replay.
ReplayInteraction.Builder - class in com.google.genai.types.ReplayInteraction
Builder for ReplayInteraction.
ReplayRequest - class in com.google.genai.types
Represents a single request in a replay.
ReplayRequest.Builder - class in com.google.genai.types.ReplayRequest
Builder for ReplayRequest.
ReplayResponse - class in com.google.genai.types
Represents a single response in a replay.
ReplayResponse.Builder - class in com.google.genai.types.ReplayResponse
Builder for ReplayResponse.
ReplicatedVoiceConfig - class in com.google.genai.types
The configuration for the replicated voice to use.
replicatedVoiceConfig() - function in com.google.genai.types.VoiceConfig
The configuration for a replicated voice, which is a clone of a user's voice that can be used for speech synthesis.
replicatedVoiceConfig(com.google.genai.types.ReplicatedVoiceConfig) - function in com.google.genai.types.VoiceConfig.Builder
Setter for replicatedVoiceConfig.
replicatedVoiceConfig(com.google.genai.types.ReplicatedVoiceConfig.Builder) - function in com.google.genai.types.VoiceConfig.Builder
Setter for replicatedVoiceConfig builder.
ReplicatedVoiceConfig.Builder - class in com.google.genai.types.ReplicatedVoiceConfig
Builder for ReplicatedVoiceConfig.
request(java.lang.String,java.lang.String,kotlin.Array,java.util.Optional) - function in com.google.genai.ApiClient
Sends a Http request given the http method, path, and request bytes.
request(java.lang.String,java.lang.String,java.lang.String,java.util.Optional) - function in com.google.genai.ApiClient
Sends a Http request given the http method, path, and request json string.
request(java.lang.String,java.lang.String,kotlin.Array,java.util.Optional) - function in com.google.genai.HttpApiClient
Sends a Http request given the http method, path, request bytes, and http options.
request(java.lang.String,java.lang.String,java.lang.String,java.util.Optional) - function in com.google.genai.HttpApiClient
Sends a Http request given the http method, path, request json string, and http options.
request(java.lang.String,java.lang.String,kotlin.Array,java.util.Optional) - function in com.google.genai.ReplayApiClient
Sends a Http request given the http method, path, request bytes, and http options.
request(java.lang.String,java.lang.String,java.lang.String,java.util.Optional) - function in com.google.genai.ReplayApiClient
Sends a Http Post request given the path and request json string.
request() - function in com.google.genai.types.ReplayInteraction
 
request(com.google.genai.types.ReplayRequest) - function in com.google.genai.types.ReplayInteraction.Builder
Setter for request.
request(com.google.genai.types.ReplayRequest.Builder) - function in com.google.genai.types.ReplayInteraction.Builder
Setter for request builder.
required() - function in com.google.genai.types.Schema
Optional.
required(kotlin.Array) - function in com.google.genai.types.Schema.Builder
Setter for required.
required(java.util.List) - function in com.google.genai.types.Schema.Builder
Setter for required.
resolution() - function in com.google.genai.types.GenerateVideosConfig
The resolution for the generated video.
resolution(java.lang.String) - function in com.google.genai.types.GenerateVideosConfig.Builder
Setter for resolution.
RESOURCE_SCOPE_UNSPECIFIED - enum entry in com.google.genai.types.ResourceScope.Known
 
resourceName() - function in com.google.genai.types.FetchPredictOperationParameters
 
resourceName(java.lang.String) - function in com.google.genai.types.FetchPredictOperationParameters.Builder
Setter for resourceName.
ResourceScope - class in com.google.genai.types
Resource scope.
ResourceScope.Known - class in com.google.genai.types.ResourceScope
Enum representing the known values for ResourceScope.
response() - function in com.google.genai.types.FunctionDeclaration
Optional.
response(com.google.genai.types.Schema) - function in com.google.genai.types.FunctionDeclaration.Builder
Setter for response.
response(com.google.genai.types.Schema.Builder) - function in com.google.genai.types.FunctionDeclaration.Builder
Setter for response builder.
response() - function in com.google.genai.types.FunctionResponse
Required.
response(java.util.Map) - function in com.google.genai.types.FunctionResponse.Builder
Setter for response.
response() - function in com.google.genai.types.GenerateVideosOperation
The generated videos.
response(com.google.genai.types.GenerateVideosResponse) - function in com.google.genai.types.GenerateVideosOperation.Builder
Setter for response.
response(com.google.genai.types.GenerateVideosResponse.Builder) - function in com.google.genai.types.GenerateVideosOperation.Builder
Setter for response builder.
response() - function in com.google.genai.types.ImportFileOperation
The result of the ImportFile operation, available when the operation is done.
response(com.google.genai.types.ImportFileResponse) - function in com.google.genai.types.ImportFileOperation.Builder
Setter for response.
response(com.google.genai.types.ImportFileResponse.Builder) - function in com.google.genai.types.ImportFileOperation.Builder
Setter for response builder.
response() - function in com.google.genai.types.InlinedEmbedContentResponse
Output only.
response(com.google.genai.types.SingleEmbedContentResponse) - function in com.google.genai.types.InlinedEmbedContentResponse.Builder
Setter for response.
response(com.google.genai.types.SingleEmbedContentResponse.Builder) - function in com.google.genai.types.InlinedEmbedContentResponse.Builder
Setter for response builder.
response() - function in com.google.genai.types.InlinedResponse
The response to the request.
response(com.google.genai.types.GenerateContentResponse) - function in com.google.genai.types.InlinedResponse.Builder
Setter for response.
response(com.google.genai.types.GenerateContentResponse.Builder) - function in com.google.genai.types.InlinedResponse.Builder
Setter for response builder.
response() - function in com.google.genai.types.Operation
The result of the operation.
response() - function in com.google.genai.types.ReplayInteraction
 
response(com.google.genai.types.ReplayResponse) - function in com.google.genai.types.ReplayInteraction.Builder
Setter for response.
response(com.google.genai.types.ReplayResponse.Builder) - function in com.google.genai.types.ReplayInteraction.Builder
Setter for response builder.
response() - function in com.google.genai.types.ToolResponse
The tool response.
response(java.util.Map) - function in com.google.genai.types.ToolResponse.Builder
Setter for response.
response() - function in com.google.genai.types.UploadToFileSearchStoreOperation
The result of the UploadToFileSearchStore operation, available when the operation is done.
response(com.google.genai.types.UploadToFileSearchStoreResponse) - function in com.google.genai.types.UploadToFileSearchStoreOperation.Builder
Setter for response.
response(com.google.genai.types.UploadToFileSearchStoreResponse.Builder) - function in com.google.genai.types.UploadToFileSearchStoreOperation.Builder
Setter for response builder.
RESPONSE_REJECTED - enum entry in com.google.genai.types.TurnCompleteReason.Known

The response is rejected by the model.

responseId() - function in com.google.genai.types.GenerateContentResponse
Output only.
responseId(java.lang.String) - function in com.google.genai.types.GenerateContentResponse.Builder
Setter for responseId.
responseJsonSchema() - function in com.google.genai.types.FunctionDeclaration
Optional.
responseJsonSchema(Object) - function in com.google.genai.types.FunctionDeclaration.Builder
Setter for responseJsonSchema.
responseJsonSchema() - function in com.google.genai.types.GenerateContentConfig
Optional.
responseJsonSchema(Object) - function in com.google.genai.types.GenerateContentConfig.Builder
Setter for responseJsonSchema.
responseJsonSchema() - function in com.google.genai.types.GenerationConfig
Output schema of the generated response.
responseJsonSchema(Object) - function in com.google.genai.types.GenerationConfig.Builder
Setter for responseJsonSchema.
responseLogprobs() - function in com.google.genai.types.GenerateContentConfig
Whether to return the log probabilities of the tokens that were chosen by the model at each step.
responseLogprobs(boolean) - function in com.google.genai.types.GenerateContentConfig.Builder
Setter for responseLogprobs.
responseLogprobs() - function in com.google.genai.types.GenerationConfig
Optional.
responseLogprobs(boolean) - function in com.google.genai.types.GenerationConfig.Builder
Setter for responseLogprobs.
responseMimeType() - function in com.google.genai.types.GenerateContentConfig
Output response mimetype of the generated candidate text.
responseMimeType(java.lang.String) - function in com.google.genai.types.GenerateContentConfig.Builder
Setter for responseMimeType.
responseMimeType() - function in com.google.genai.types.GenerationConfig
Optional.
responseMimeType(java.lang.String) - function in com.google.genai.types.GenerationConfig.Builder
Setter for responseMimeType.
responseModalities() - function in com.google.genai.types.GenerateContentConfig
The requested modalities of the response.
responseModalities(kotlin.Array) - function in com.google.genai.types.GenerateContentConfig.Builder
Setter for responseModalities.
responseModalities(java.util.List) - function in com.google.genai.types.GenerateContentConfig.Builder
Setter for responseModalities.
responseModalities() - function in com.google.genai.types.GenerationConfig
Optional.
responseModalities(kotlin.Array) - function in com.google.genai.types.GenerationConfig.Builder
Setter for responseModalities.
responseModalities(kotlin.Array) - function in com.google.genai.types.GenerationConfig.Builder
Setter for responseModalities given a varargs of known enums.
responseModalities(kotlin.Array) - function in com.google.genai.types.GenerationConfig.Builder
Setter for responseModalities given a varargs of strings.
responseModalities(java.util.List) - function in com.google.genai.types.GenerationConfig.Builder
Setter for responseModalities.
responseModalities() - function in com.google.genai.types.LiveConnectConfig
The requested modalities of the response.
responseModalities(kotlin.Array) - function in com.google.genai.types.LiveConnectConfig.Builder
Setter for responseModalities.
responseModalities(kotlin.Array) - function in com.google.genai.types.LiveConnectConfig.Builder
Setter for responseModalities given a varargs of known enums.
responseModalities(kotlin.Array) - function in com.google.genai.types.LiveConnectConfig.Builder
Setter for responseModalities given a varargs of strings.
responseModalities(java.util.List) - function in com.google.genai.types.LiveConnectConfig.Builder
Setter for responseModalities.
responseModalitiesFromKnown(java.util.List) - function in com.google.genai.types.GenerationConfig.Builder
Setter for responseModalities given a list of known enums.
responseModalitiesFromKnown(java.util.List) - function in com.google.genai.types.LiveConnectConfig.Builder
Setter for responseModalities given a list of known enums.
responseModalitiesFromString(java.util.List) - function in com.google.genai.types.GenerationConfig.Builder
Setter for responseModalities given a list of strings.
responseModalitiesFromString(java.util.List) - function in com.google.genai.types.LiveConnectConfig.Builder
Setter for responseModalities given a list of strings.
responseSchema() - function in com.google.genai.types.GenerateContentConfig
The `Schema` object allows the definition of input and output data types.
responseSchema(com.google.genai.types.Schema) - function in com.google.genai.types.GenerateContentConfig.Builder
Setter for responseSchema.
responseSchema(com.google.genai.types.Schema.Builder) - function in com.google.genai.types.GenerateContentConfig.Builder
Setter for responseSchema builder.
responseSchema() - function in com.google.genai.types.GenerationConfig
Optional.
responseSchema(com.google.genai.types.Schema) - function in com.google.genai.types.GenerationConfig.Builder
Setter for responseSchema.
responseSchema(com.google.genai.types.Schema.Builder) - function in com.google.genai.types.GenerationConfig.Builder
Setter for responseSchema builder.
ResponseStream - class in com.google.genai
An iterable of datatype objects.
responseTemplateName() - function in com.google.genai.types.ModelArmorConfig
Optional.
responseTemplateName(java.lang.String) - function in com.google.genai.types.ModelArmorConfig.Builder
Setter for responseTemplateName.
responseTokenCount() - function in com.google.genai.types.UsageMetadata
Total number of tokens across all the generated response candidates.
responseTokenCount(java.lang.Integer) - function in com.google.genai.types.UsageMetadata.Builder
Setter for responseTokenCount.
responseTokensDetails() - function in com.google.genai.types.UsageMetadata
List of modalities that were returned in the response.
responseTokensDetails(kotlin.Array) - function in com.google.genai.types.UsageMetadata.Builder
Setter for responseTokensDetails.
responseTokensDetails(kotlin.Array) - function in com.google.genai.types.UsageMetadata.Builder
Setter for responseTokensDetails builder.
responseTokensDetails(java.util.List) - function in com.google.genai.types.UsageMetadata.Builder
Setter for responseTokensDetails.
resumable() - function in com.google.genai.types.LiveServerSessionResumptionUpdate
True if session can be resumed at this point.
resumable(boolean) - function in com.google.genai.types.LiveServerSessionResumptionUpdate.Builder
Setter for resumable.
RETIRED - enum entry in com.google.genai.types.ModelStage.Known

Models in this stage are retired. These models cannot be used.

retirementTime() - function in com.google.genai.types.ModelStatus
The time at which the model will be retired.
retirementTime(java.time.Instant) - function in com.google.genai.types.ModelStatus.Builder
Setter for retirementTime.
Retrieval - class in com.google.genai.types
Defines a retrieval tool that model can call to access external knowledge.
retrieval() - function in com.google.genai.types.Tool
Optional.
retrieval(com.google.genai.types.Retrieval) - function in com.google.genai.types.Tool.Builder
Setter for retrieval.
retrieval(com.google.genai.types.Retrieval.Builder) - function in com.google.genai.types.Tool.Builder
Setter for retrieval builder.
Retrieval.Builder - class in com.google.genai.types.Retrieval
Builder for Retrieval.
RetrievalConfig - class in com.google.genai.types
Retrieval config.
retrievalConfig() - function in com.google.genai.types.ToolConfig
Optional.
retrievalConfig(com.google.genai.types.RetrievalConfig) - function in com.google.genai.types.ToolConfig.Builder
Setter for retrievalConfig.
retrievalConfig(com.google.genai.types.RetrievalConfig.Builder) - function in com.google.genai.types.ToolConfig.Builder
Setter for retrievalConfig builder.
RetrievalConfig.Builder - class in com.google.genai.types.RetrievalConfig
Builder for RetrievalConfig.
retrievalMetadata() - function in com.google.genai.types.GroundingMetadata
Metadata related to retrieval in the grounding flow.
retrievalMetadata(com.google.genai.types.RetrievalMetadata) - function in com.google.genai.types.GroundingMetadata.Builder
Setter for retrievalMetadata.
retrievalMetadata(com.google.genai.types.RetrievalMetadata.Builder) - function in com.google.genai.types.GroundingMetadata.Builder
Setter for retrievalMetadata builder.
RetrievalMetadata - class in com.google.genai.types
Metadata returned to client when grounding is enabled.
RetrievalMetadata.Builder - class in com.google.genai.types.RetrievalMetadata
Builder for RetrievalMetadata.
retrievalQueries() - function in com.google.genai.types.GroundingMetadata
Optional.
retrievalQueries(kotlin.Array) - function in com.google.genai.types.GroundingMetadata.Builder
Setter for retrievalQueries.
retrievalQueries(java.util.List) - function in com.google.genai.types.GroundingMetadata.Builder
Setter for retrievalQueries.
retrievedContext() - function in com.google.genai.types.GroundingChunk
A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search.
retrievedContext(com.google.genai.types.GroundingChunkRetrievedContext) - function in com.google.genai.types.GroundingChunk.Builder
Setter for retrievedContext.
retrievedContext(com.google.genai.types.GroundingChunkRetrievedContext.Builder) - function in com.google.genai.types.GroundingChunk.Builder
Setter for retrievedContext builder.
retrievedUrl() - function in com.google.genai.types.UrlMetadata
The URL retrieved by the tool.
retrievedUrl(java.lang.String) - function in com.google.genai.types.UrlMetadata.Builder
Setter for retrievedUrl.
retryOptions() - function in com.google.genai.types.HttpOptions
HTTP retry options for the request.
retryOptions(com.google.genai.types.HttpRetryOptions) - function in com.google.genai.types.HttpOptions.Builder
Setter for retryOptions.
retryOptions(com.google.genai.types.HttpRetryOptions.Builder) - function in com.google.genai.types.HttpOptions.Builder
Setter for retryOptions builder.
returnRawOutput() - function in com.google.genai.types.CustomOutputFormatConfig
Optional.
returnRawOutput(boolean) - function in com.google.genai.types.CustomOutputFormatConfig.Builder
Setter for returnRawOutput.
returnRawOutput() - function in com.google.genai.types.Metric
Whether to return the raw output from the judge model.
returnRawOutput(boolean) - function in com.google.genai.types.Metric.Builder
Setter for returnRawOutput.
review() - function in com.google.genai.types.GroundingChunkMapsPlaceAnswerSourcesReviewSnippet
A reference representing this place review which may be used to look up this place review again.
review(java.lang.String) - function in com.google.genai.types.GroundingChunkMapsPlaceAnswerSourcesReviewSnippet.Builder
Setter for review.
reviewId() - function in com.google.genai.types.GroundingChunkMapsPlaceAnswerSourcesReviewSnippet
Id of the review referencing the place.
reviewId(java.lang.String) - function in com.google.genai.types.GroundingChunkMapsPlaceAnswerSourcesReviewSnippet.Builder
Setter for reviewId.
reviewSnippet() - function in com.google.genai.types.GroundingChunkMapsPlaceAnswerSources
Snippets of reviews that were used to generate the answer.
reviewSnippet(kotlin.Array) - function in com.google.genai.types.GroundingChunkMapsPlaceAnswerSources.Builder
Setter for reviewSnippet.
reviewSnippet(kotlin.Array) - function in com.google.genai.types.GroundingChunkMapsPlaceAnswerSources.Builder
Setter for reviewSnippet builder.
reviewSnippet(java.util.List) - function in com.google.genai.types.GroundingChunkMapsPlaceAnswerSources.Builder
Setter for reviewSnippet.
reviewSnippets() - function in com.google.genai.types.GroundingChunkMapsPlaceAnswerSources
Snippets of reviews that were used to generate the answer.
reviewSnippets(kotlin.Array) - function in com.google.genai.types.GroundingChunkMapsPlaceAnswerSources.Builder
Setter for reviewSnippets.
reviewSnippets(kotlin.Array) - function in com.google.genai.types.GroundingChunkMapsPlaceAnswerSources.Builder
Setter for reviewSnippets builder.
reviewSnippets(java.util.List) - function in com.google.genai.types.GroundingChunkMapsPlaceAnswerSources.Builder
Setter for reviewSnippets.
right() - function in com.google.genai.types.DatasetDistributionDistributionBucket
Output only.
right(java.lang.Double) - function in com.google.genai.types.DatasetDistributionDistributionBucket.Builder
Setter for right.
right() - function in com.google.genai.types.SupervisedTuningDatasetDistributionDatasetBucket
Output only.
right(java.lang.Double) - function in com.google.genai.types.SupervisedTuningDatasetDistributionDatasetBucket.Builder
Setter for right.
role() - function in com.google.genai.types.Content
Optional.
role(java.lang.String) - function in com.google.genai.types.Content.Builder
Setter for role.
role() - function in com.google.genai.types.TokensInfo
Optional fields for the role from the corresponding Content.
role(java.lang.String) - function in com.google.genai.types.TokensInfo.Builder
Setter for role.
ROUGE - enum entry in com.google.genai.types.ComputationBasedMetricType.Known

ROUGE metric.

rougeMetricValue() - function in com.google.genai.types.AggregationResult
Results for rouge metric.
rougeMetricValue(com.google.genai.types.RougeMetricValue) - function in com.google.genai.types.AggregationResult.Builder
Setter for rougeMetricValue.
rougeMetricValue(com.google.genai.types.RougeMetricValue.Builder) - function in com.google.genai.types.AggregationResult.Builder
Setter for rougeMetricValue builder.
RougeMetricValue - class in com.google.genai.types
Rouge metric value for an instance.
RougeMetricValue.Builder - class in com.google.genai.types.RougeMetricValue
Builder for RougeMetricValue.
RougeSpec - class in com.google.genai.types
Spec for rouge metric.
rougeSpec() - function in com.google.genai.types.UnifiedMetric
The rouge metric spec.
rougeSpec(com.google.genai.types.RougeSpec) - function in com.google.genai.types.UnifiedMetric.Builder
Setter for rougeSpec.
rougeSpec(com.google.genai.types.RougeSpec.Builder) - function in com.google.genai.types.UnifiedMetric.Builder
Setter for rougeSpec builder.
RougeSpec.Builder - class in com.google.genai.types.RougeSpec
Builder for RougeSpec.
rougeType() - function in com.google.genai.types.RougeSpec
Optional.
rougeType(java.lang.String) - function in com.google.genai.types.RougeSpec.Builder
Setter for rougeType.
route() - function in com.google.genai.types.GroundingChunkMaps
Output only.
route(com.google.genai.types.GroundingChunkMapsRoute) - function in com.google.genai.types.GroundingChunkMaps.Builder
Setter for route.
route(com.google.genai.types.GroundingChunkMapsRoute.Builder) - function in com.google.genai.types.GroundingChunkMaps.Builder
Setter for route builder.
routingConfig() - function in com.google.genai.types.GenerateContentConfig
Configuration for model router requests.
routingConfig(com.google.genai.types.GenerationConfigRoutingConfig) - function in com.google.genai.types.GenerateContentConfig.Builder
Setter for routingConfig.
routingConfig(com.google.genai.types.GenerationConfigRoutingConfig.Builder) - function in com.google.genai.types.GenerateContentConfig.Builder
Setter for routingConfig builder.
routingConfig() - function in com.google.genai.types.GenerationConfig
Optional.
routingConfig(com.google.genai.types.GenerationConfigRoutingConfig) - function in com.google.genai.types.GenerationConfig.Builder
Setter for routingConfig.
routingConfig(com.google.genai.types.GenerationConfigRoutingConfig.Builder) - function in com.google.genai.types.GenerationConfig.Builder
Setter for routingConfig builder.
RUBRIC_CONTENT_TYPE_UNSPECIFIED - enum entry in com.google.genai.types.RubricContentType.Known

The content type to generate is not specified.

RubricContentType - class in com.google.genai.types
The type of rubric content to be generated.
rubricContentType() - function in com.google.genai.types.RubricGenerationSpec
The type of rubric content to be generated.
rubricContentType(com.google.genai.types.RubricContentType) - function in com.google.genai.types.RubricGenerationSpec.Builder
Setter for rubricContentType.
rubricContentType(com.google.genai.types.RubricContentType.Known) - function in com.google.genai.types.RubricGenerationSpec.Builder
Setter for rubricContentType given a known enum.
rubricContentType(java.lang.String) - function in com.google.genai.types.RubricGenerationSpec.Builder
Setter for rubricContentType given a string.
RubricContentType.Known - class in com.google.genai.types.RubricContentType
Enum representing the known values for RubricContentType.
rubricGenerationSpec() - function in com.google.genai.types.LLMBasedMetricSpec
Dynamically generate rubrics using this specification.
rubricGenerationSpec(com.google.genai.types.RubricGenerationSpec) - function in com.google.genai.types.LLMBasedMetricSpec.Builder
Setter for rubricGenerationSpec.
rubricGenerationSpec(com.google.genai.types.RubricGenerationSpec.Builder) - function in com.google.genai.types.LLMBasedMetricSpec.Builder
Setter for rubricGenerationSpec builder.
RubricGenerationSpec - class in com.google.genai.types
Specification for how rubrics should be generated.
RubricGenerationSpec.Builder - class in com.google.genai.types.RubricGenerationSpec
Builder for RubricGenerationSpec.
rubricGroupKey() - function in com.google.genai.types.LLMBasedMetricSpec
Use a pre-defined group of rubrics associated with the input.
rubricGroupKey(java.lang.String) - function in com.google.genai.types.LLMBasedMetricSpec.Builder
Setter for rubricGroupKey.
rubricTypeOntology() - function in com.google.genai.types.RubricGenerationSpec
Optional.
rubricTypeOntology(kotlin.Array) - function in com.google.genai.types.RubricGenerationSpec.Builder
Setter for rubricTypeOntology.
rubricTypeOntology(java.util.List) - function in com.google.genai.types.RubricGenerationSpec.Builder
Setter for rubricTypeOntology.
A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  Y  Z