All Classes and Interfaces
Classes
Class
Description
The API response contains a response to a call to the GenAI APIs.
Content blob.
Builder for Blob.
A response candidate generated from the model.
Builder for Candidate.
Source attributions for content.
Builder for Citation.
Citation information when the model quotes another source.
Builder for CitationMetadata.
Client class for GenAI.
Builder for
Client.Result of executing the [ExecutableCode].
Builder for CodeExecutionResult.
Common utility methods for the GenAI SDK.
Contains the multi-part content of a message.
Builder for Content.
Configuration for a Control reference image.
Builder for ControlReferenceConfig.
A control reference image.
Builder for ControlReferenceImage.
Describes the options to customize dynamic retrieval.
Builder for DynamicRetrievalConfig.
Code generated by the model that is meant to be executed, and the result returned to the model.
Builder for ExecutableCode.
URI based data.
Builder for FileData.
A function call.
Builder for FunctionCall.
Function calling config.
Builder for FunctionCallingConfig.
Defines a function that the model can generate JSON inputs for.
Builder for FunctionDeclaration.
A function response.
Builder for FunctionResponse.
Optional model configuration parameters.
Builder for GenerateContentConfig.
Config for models.generate_content parameters.
Builder for GenerateContentParameters.
Response message for PredictionService.GenerateContent.
Builder for GenerateContentResponse.
Content filter results for a prompt sent in the request.
Builder for GenerateContentResponsePromptFeedback.
Usage metadata about response(s).
Builder for GenerateContentResponseUsageMetadata.
An output image.
Builder for GeneratedImage.
The config for generating an images.
Builder for GenerateImagesConfig.
The parameters for generating images.
Builder for GenerateImagesParameters.
The output images response.
Builder for GenerateImagesResponse.
Generation config.
Builder for GenerationConfig.
The configuration for routing the request to a specific model.
Builder for GenerationConfigRoutingConfig.
When automated routing is specified, the routing will be determined by the pretrained routing
model and customer provided model routing preference.
Builder for GenerationConfigRoutingConfigAutoRoutingMode.
When manual routing is set, the specified model will be used directly.
Builder for GenerationConfigRoutingConfigManualRoutingMode.
Tool to support Google Search in Model.
Builder for GoogleSearch.
Tool to retrieve public web data for grounding, powered by Google.
Builder for GoogleSearchRetrieval.
Represents a whole or partial calendar date, such as a birthday.
Builder for GoogleTypeDate.
Grounding chunk.
Builder for GroundingChunk.
Chunk from context retrieved by the retrieval tools.
Builder for GroundingChunkRetrievedContext.
Chunk from the web.
Builder for GroundingChunkWeb.
Metadata returned to client when grounding is enabled.
Builder for GroundingMetadata.
Grounding support.
Builder for GroundingSupport.
HTTP options to be used in each of the requests.
Builder for HttpOptions.
An image.
Builder for Image.
A class that can be serialized to JSON and deserialized from JSON.
Logprobs Result
Builder for LogprobsResult.
Candidate for the logprobs token and score.
Builder for LogprobsResultCandidate.
Candidates with top log probabilities at each decoding step.
Builder for LogprobsResultTopCandidates.
Configuration for a Mask reference image.
Builder for MaskReferenceConfig.
A mask reference image.
Builder for MaskReferenceImage.
A datatype containing media content.
Builder for Part.
The configuration for the prebuilt speaker to use.
Builder for PrebuiltVoiceConfig.
A raw reference image.
Builder for RawReferenceImage.
Represents a recorded session.
Builder for ReplayFile.
Represents a single interaction, request and response in a replay.
Builder for ReplayInteraction.
Represents a single request in a replay.
Builder for ReplayRequest.
Represents a single response in a replay.
Builder for ReplayResponse.
An iterable of datatype objects.
Defines a retrieval tool that model can call to access external knowledge.
Builder for Retrieval.
Metadata related to retrieval in the grounding flow.
Builder for RetrievalMetadata.
Safety rating corresponding to the generated content.
Builder for SafetyRating.
Safety settings.
Builder for SafetySetting.
Schema that defines the format of input and output data.
Builder for Schema.
Google search entry point.
Builder for SearchEntryPoint.
Segment of the content.
Builder for Segment.
The speech generation configuration.
Builder for SpeechConfig.
Configuration for a Style reference image.
Builder for StyleReferenceConfig.
A style reference image.
Builder for StyleReferenceImage.
Configuration for a Subject reference image.
Builder for SubjectReferenceConfig.
A subject reference image.
Builder for SubjectReferenceImage.
None
Builder for TestTableFile.
None
Builder for TestTableItem.
The thinking features configuration.
Builder for ThinkingConfig.
Tool details of a tool that the model may use to generate a response.
Builder for Tool.
Tool that executes code generated by the model, and automatically returns the result to the
model.
Builder for ToolCodeExecution.
Tool config.
Builder for ToolConfig.
Used to override the default configuration.
Builder for UploadFileConfig.
API config for UpscaleImage with fields not exposed to users.
Builder for UpscaleImageAPIConfig.
API parameters for UpscaleImage.
Builder for UpscaleImageAPIParameters.
Configuration for upscaling an image.
Builder for UpscaleImageConfig.
User-facing config UpscaleImageParameters.
Builder for UpscaleImageParameters.
None
Builder for UpscaleImageResponse.
Retrieve from Vertex AI Search datastore for grounding.
Builder for VertexAISearch.
Retrieve from Vertex RAG Store for grounding.
Builder for VertexRagStore.
The definition of the Rag resource.
Builder for VertexRagStoreRagResource.
Metadata describes the input video content.
Builder for VideoMetadata.
The configuration for the voice to use.
Builder for VoiceConfig.