Package com.google.genai.types
See: Description
-
Class Summary Class Description Builder Builder for ModelArmorConfig. ModelArmorConfig Configuration for Model Armor. Builder Builder for ListCachedContentsParameters. ListCachedContentsParameters Parameters for caches.list method. Builder Builder for LiveConnectConfig. LiveConnectConfig Session config for the API connection. Builder Builder for HttpOptions. HttpOptions HTTP options to be used in each of the requests. ProminentPeople Controls whether prominent people (celebrities) generation is allowed. Builder Builder for GeneratedVideo. GeneratedVideo A generated video. Builder Builder for McpServer. McpServer A MCPServer is a server that can be called by the model to perform actions. Builder Builder for TunedModelCheckpoint. TunedModelCheckpoint TunedModelCheckpoint for the Tuned Model of a Tuning Job. Builder Builder for GeminiPreferenceExample. GeminiPreferenceExample Input example for preference optimization. Builder Builder for VoiceActivityDetectionSignal. VoiceActivityDetectionSignal None Builder Builder for Document. Document A Document is a collection of Chunks. Builder Builder for SpeechConfig. SpeechConfig Config for speech generation and transcription. Builder Builder for SegmentImageResponse. SegmentImageResponse The output images response. Builder Builder for ApiKeyConfig. ApiKeyConfig Config for authentication with API key. Builder Builder for AutomaticActivityDetection. AutomaticActivityDetection Configures automatic detection of activity. Builder Builder for ImageConfig. ImageConfig The image generation configuration to be used in GenerateContentConfig. Builder Builder for UpscaleImageAPIParameters. UpscaleImageAPIParameters API parameters for UpscaleImage. Builder Builder for ListFilesResponse. ListFilesResponse Response for the list files method. Builder Builder for OutputConfig. OutputConfig Config for evaluation output. ToolType The type of tool in the function call. Builder Builder for CustomCodeExecutionResult. CustomCodeExecutionResult Result for custom code execution metric. Builder Builder for GenerateContentConfig. GenerateContentConfig Optional model configuration parameters. Builder Builder for SearchEntryPoint. SearchEntryPoint The entry point used to search for grounding sources. Builder Builder for PointwiseMetricSpec. PointwiseMetricSpec Spec for pointwise metric. FeatureSelectionPreference Options for feature selection preference. Builder Builder for InlinedResponse. InlinedResponse Config for `inlined_responses` parameter. AggregationMetric Aggregation metric. Builder Builder for VideoMetadata. VideoMetadata Provides metadata for a video, including the start and end offsets for clipping and the frame rate. Builder Builder for LiveSendClientContentParameters. LiveSendClientContentParameters Parameters for sending client content to the live API. DocumentState Output only. Builder Builder for ReplayRequest. ReplayRequest Represents a single request in a replay. Builder Builder for ContentReferenceImage. ContentReferenceImage A content reference image. BlockedReason Output only. Builder Builder for UploadToFileSearchStoreParameters. UploadToFileSearchStoreParameters Generates the parameters for the private _upload_to_file_search_store method. Builder Builder for CancelTuningJobConfig. CancelTuningJobConfig Optional parameters for tunings.cancel method. Builder Builder for TunedModel. TunedModel TunedModel for the Tuned Model of a Tuning Job. Builder Builder for GroundingChunkMaps. GroundingChunkMaps A `Maps` chunk is a piece of evidence that comes from Google Maps. Builder Builder for UrlMetadata. UrlMetadata The metadata for a single URL retrieval. Builder Builder for DeleteDocumentParameters. DeleteDocumentParameters Config for documents.delete parameters. Builder Builder for FunctionResponseBlob. FunctionResponseBlob Raw media bytes for function response. Builder Builder for RealtimeInputConfig. RealtimeInputConfig Marks the end of user activity. Builder Builder for ToolParallelAiSearch. ToolParallelAiSearch ParallelAiSearch tool type. Builder Builder for GroundingMetadataSourceFlaggingUri. GroundingMetadataSourceFlaggingUri A URI that can be used to flag a place or review for inappropriate content. Builder Builder for GroundingMetadata. GroundingMetadata Information for various kinds of grounding. Builder Builder for Candidate. Candidate A response candidate generated from the model. EditMode Enum representing the editing mode. Builder Builder for EntityLabel. EntityLabel An entity representing the segmented area. Builder Builder for CountTokensConfig. CountTokensConfig Config for the count_tokens method. Builder Builder for JobError. JobError Job error. Builder Builder for CreateTuningJobParameters. CreateTuningJobParameters Fine-tuning job creation parameters - optional fields. Builder Builder for RagRetrievalConfigRanking. RagRetrievalConfigRanking Config for ranking and reranking. Builder Builder for ImageSearch. ImageSearch Image search for grounding and related configurations. Builder Builder for CreateCachedContentConfig. CreateCachedContentConfig Optional configuration for cached content creation. Builder Builder for GetCachedContentConfig. GetCachedContentConfig Optional parameters for caches.get method. Builder Builder for DeleteFileParameters. DeleteFileParameters Generates the parameters for the get method. Builder Builder for ActivityEnd. ActivityEnd Marks the end of user activity. Builder Builder for FullFineTuningSpec. FullFineTuningSpec Tuning Spec for Full Fine Tuning. ProxyType Specifies the type of proxy to use for network connections. Environment The environment being operated. Builder Builder for SafetySetting. SafetySetting A safety setting that affects the safety-blocking behavior. Builder Builder for LiveSendRealtimeInputParameters. LiveSendRealtimeInputParameters Parameters for sending realtime input to the live API. Builder Builder for ImportFileOperation. ImportFileOperation Long-running operation for importing a file to a FileSearchStore. Builder Builder for Interval. Interval Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). Builder Builder for RagChunk. RagChunk A RagChunk includes the content of a chunk of a RagFile, and associated metadata. Builder Builder for EmbedContentBatch. EmbedContentBatch Parameters for the embed_content method. Builder Builder for EmbeddingsBatchJobSource. EmbeddingsBatchJobSource None Builder Builder for CreateFileParameters. CreateFileParameters Generates the parameters for the private _create method. Builder Builder for VertexMultimodalDatasetDestination. VertexMultimodalDatasetDestination This class is experimental and may change in future versions. Builder Builder for DeleteFileSearchStoreParameters. DeleteFileSearchStoreParameters Config for file_search_stores.delete parameters. Builder Builder for ThinkingConfig. ThinkingConfig The thinking features configuration. VadSignalType The type of the VAD signal. Builder Builder for CountTokensResult. CountTokensResult Local tokenizer count tokens result. Builder Builder for GcsDestination. GcsDestination The Google Cloud Storage location where the output is to be written to. FunctionCallingConfigMode Function calling mode. Builder Builder for AuthToken. AuthToken Config for auth_tokens.create parameters. Builder Builder for DeleteModelParameters. DeleteModelParameters Parameters for deleting a tuned model. Builder Builder for ListCachedContentsConfig. ListCachedContentsConfig Config for caches.list method. Builder Builder for FunctionResponse. FunctionResponse A function response. Builder Builder for File. File A file uploaded to the API. Builder Builder for GroundingChunkCustomMetadata. GroundingChunkCustomMetadata User provided metadata about the GroundingFact. Builder Builder for DeleteModelConfig. DeleteModelConfig Configuration for deleting a tuned model. Builder Builder for ExternalApi. ExternalApi Retrieve from data source powered by external API for grounding. Builder Builder for GetFileSearchStoreConfig. GetFileSearchStoreConfig Optional parameters for getting a FileSearchStore. FileState State for the lifecycle of a File. Builder Builder for RagRetrievalConfigRankingLlmRanker. RagRetrievalConfigRankingLlmRanker Config for LlmRanker. ActivityHandling The different ways of handling user activity. Builder Builder for VertexAISearch. VertexAISearch Retrieve from Vertex AI Search datastore or engine for grounding. FileSource Source of the File. Builder Builder for GenerateVideosSource. GenerateVideosSource A set of source input(s) for video generation. Builder Builder for VertexRagStoreRagResource. VertexRagStoreRagResource The definition of the Rag resource. Builder Builder for EvaluateDatasetRun. EvaluateDatasetRun Evaluate Dataset Run Result for Tuning Job. Builder Builder for WebSearch. WebSearch Standard web search for grounding and related configurations. Builder Builder for OutputInfo. OutputInfo Describes the info for output of EvaluationService. PairwiseChoice Output only. Builder Builder for RagRetrievalConfigHybridSearch. RagRetrievalConfigHybridSearch Config for Hybrid Search. Builder Builder for AggregationResult. AggregationResult The aggregation result for a single metric. Builder Builder for GoogleTypeDate. GoogleTypeDate Represents a whole or partial calendar date, such as a birthday. Builder Builder for Checkpoint. Checkpoint Describes the machine learning model version checkpoint. Builder Builder for FetchPredictOperationParameters. FetchPredictOperationParameters Parameters for the fetchPredictOperation method. Builder Builder for ControlReferenceImage. ControlReferenceImage A control reference image. Builder Builder for CancelBatchJobParameters. CancelBatchJobParameters Config for batches.cancel parameters. Builder Builder for PartnerModelTuningSpec. PartnerModelTuningSpec Tuning spec for Partner models. Builder Builder for VideoGenerationReferenceImage. VideoGenerationReferenceImage A reference image for video generation. ThinkingLevel The number of thoughts tokens that the model should generate. Builder Builder for DeleteBatchJobConfig. DeleteBatchJobConfig Optional parameters for models.get method. Builder Builder for ReplayResponse. ReplayResponse Represents a single response in a replay. Builder Builder for CreateFileConfig. CreateFileConfig Used to override the default configuration. Builder Builder for RetrievalMetadata. RetrievalMetadata Metadata returned to client when grounding is enabled. Builder Builder for CustomOutput. CustomOutput Spec for custom output. Builder Builder for GroundingChunkWeb. GroundingChunkWeb A `Web` chunk is a piece of evidence that comes from a web page. Builder Builder for ModelSelectionConfig. ModelSelectionConfig Config for model selection. Builder Builder for RagChunkPageSpan. RagChunkPageSpan Represents where the chunk starts and ends in the document. Builder Builder for ProductImage. ProductImage An image of the product. Builder Builder for UpscaleImageParameters. UpscaleImageParameters User-facing config UpscaleImageParameters. Builder Builder for WhiteSpaceConfig. WhiteSpaceConfig Configuration for a white space chunking algorithm. Builder Builder for EmbedContentConfig. EmbedContentConfig Optional parameters for the embed_content method. Builder Builder for SegmentImageConfig. SegmentImageConfig Configuration for segmenting an image. Builder Builder for UpdateModelConfig. UpdateModelConfig Configuration for updating a tuned model. Builder Builder for PreferenceOptimizationHyperParameters. PreferenceOptimizationHyperParameters Hyperparameters for Preference Optimization. Builder Builder for GoogleMaps. GoogleMaps Tool to retrieve knowledge from Google Maps. AdapterSize Adapter size for tuning. Builder Builder for LiveClientMessage. LiveClientMessage Messages sent by the client in the API call. Builder Builder for RecontextImageConfig. RecontextImageConfig Configuration for recontextualizing an image. Builder Builder for EvaluationConfig. EvaluationConfig Evaluation config for tuning. Builder Builder for GenerationConfigRoutingConfigAutoRoutingMode. GenerationConfigRoutingConfigAutoRoutingMode The configuration for automated routing. Builder Builder for GoogleSearchRetrieval. GoogleSearchRetrieval Tool to retrieve public web data for grounding, powered by Google. Builder Builder for GeminiPreferenceExampleCompletion. GeminiPreferenceExampleCompletion Completion and its preference score. Builder Builder for SafetyRating. SafetyRating A safety rating for a piece of content. Builder Builder for LiveServerGoAway. LiveServerGoAway Server will not be able to service client soon. Builder Builder for DynamicRetrievalConfig. DynamicRetrievalConfig Describes the options to customize dynamic retrieval. Builder Builder for CountTokensParameters. CountTokensParameters Parameters for counting tokens. Builder Builder for ProactivityConfig. ProactivityConfig Config for proactivity features. Builder Builder for Part. Part A datatype containing media content. Builder Builder for CreateFileSearchStoreConfig. CreateFileSearchStoreConfig Optional parameters for creating a file search store. Builder Builder for AggregationOutput. AggregationOutput The aggregation result for the entire dataset and all metrics. Builder Builder for GetFileSearchStoreParameters. GetFileSearchStoreParameters Config for file_search_stores.get parameters. Builder Builder for CreateEmbeddingsBatchJobParameters. CreateEmbeddingsBatchJobParameters Config for batches.create parameters. Builder Builder for PairwiseMetricSpec. PairwiseMetricSpec Spec for pairwise metric. Builder Builder for ToolResponse. ToolResponse The output from a server-side `ToolCall` execution. Builder Builder for DatasetDistributionDistributionBucket. DatasetDistributionDistributionBucket Dataset bucket used to create a histogram for the distribution given a population of values. Builder Builder for GetDocumentParameters. GetDocumentParameters Parameters for documents.get. Builder Builder for RetrievalConfig. RetrievalConfig Retrieval config. Builder Builder for GroundingChunkMapsPlaceAnswerSources. GroundingChunkMapsPlaceAnswerSources The sources that were used to generate the place answer. Builder Builder for Blob. Blob A content blob. Builder Builder for ControlReferenceConfig. ControlReferenceConfig Configuration for a Control reference image. Builder Builder for TuningJobMetadata. TuningJobMetadata Tuning job metadata. Builder Builder for UsageMetadata. UsageMetadata Usage metadata about response(s). Behavior Specifies the function Behavior. Builder Builder for UpscaleImageConfig. UpscaleImageConfig Configuration for upscaling an image. AuthType Type of auth scheme. Builder Builder for AutomaticFunctionCallingConfig. AutomaticFunctionCallingConfig The configuration for automatic function calling. Builder Builder for MultiSpeakerVoiceConfig. MultiSpeakerVoiceConfig Configuration for a multi-speaker text-to-speech request. HarmBlockThreshold The threshold for blocking content. Builder Builder for TestTableFile. TestTableFile None Builder Builder for ReplayFile. ReplayFile Represents a recorded session. Builder Builder for VideoGenerationMask. VideoGenerationMask A mask for video generation. Builder Builder for ListModelsConfig. ListModelsConfig None Builder Builder for LogprobsResultTopCandidates. LogprobsResultTopCandidates A list of the top candidate tokens and their log probabilities at each decoding step. Builder Builder for GenerateImagesResponse. GenerateImagesResponse The output images response. Builder Builder for RecontextImageResponse. RecontextImageResponse The output images response. Builder Builder for UrlContextMetadata. UrlContextMetadata Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. Builder Builder for CancelTuningJobParameters. CancelTuningJobParameters Parameters for the cancel method. TurnCoverage Options about which input is included in the user's turn. Builder Builder for GroundingChunkStringList. GroundingChunkStringList A list of string values. Builder Builder for ClientOptions. ClientOptions Client options to be used in the client instantiation. Builder Builder for InlinedEmbedContentResponse. InlinedEmbedContentResponse Config for `inlined_embedding_responses` parameter. Builder Builder for SubjectReferenceImage. SubjectReferenceImage A subject reference image. HarmBlockMethod The method for blocking content. Builder Builder for FileSearch. FileSearch The FileSearch tool that retrieves knowledge from Semantic Retrieval corpora. Builder Builder for PointwiseMetricResult. PointwiseMetricResult Spec for pointwise metric result. Builder Builder for BigQuerySource. BigQuerySource The BigQuery location for the input content. Builder Builder for ListDocumentsParameters. ListDocumentsParameters Config for documents.list parameters. Builder Builder for SubjectReferenceConfig. SubjectReferenceConfig Configuration for a Subject reference image. Builder Builder for PreferenceOptimizationDataStats. PreferenceOptimizationDataStats Statistics computed for datasets used for preference optimization. Builder Builder for LiveServerSetupComplete. LiveServerSetupComplete Sent in response to a `LiveGenerateContentSetup` message from the client. Builder Builder for SafetyAttributes. SafetyAttributes Safety attributes of a GeneratedImage or the user-provided prompt. FunctionResponseScheduling Specifies how the response should be scheduled in the conversation. Builder Builder for DeleteCachedContentResponse. DeleteCachedContentResponse Empty response for caches.delete method. Builder Builder for DeleteResourceJob. DeleteResourceJob The return value of delete operation. Builder Builder for StringList. StringList User provided string values assigned to a single metadata key. Builder Builder for UploadFileConfig. UploadFileConfig Used to override the default configuration. Builder Builder for ListFilesConfig. ListFilesConfig Used to override the default configuration. TuningMethod Enum representing the tuning method. ImagePromptLanguage Enum that specifies the language of the text in the prompt. HarmCategory The harm category to be blocked. Builder Builder for EncryptionSpec. EncryptionSpec Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. VideoCompressionQuality Enum that controls the compression quality of the generated videos. Builder Builder for AuthConfigOidcConfig. AuthConfigOidcConfig Config for user OIDC auth. Builder Builder for ExternalApiElasticSearchParams. ExternalApiElasticSearchParams The search parameters to use for the ELASTIC_SEARCH spec. Builder Builder for CachedContentUsageMetadata. CachedContentUsageMetadata Metadata on the usage of the cached content. NullValue Optional. Builder Builder for RubricGenerationSpec. RubricGenerationSpec Specification for how rubrics should be generated. Builder Builder for BatchJobDestination. BatchJobDestination Config for `des` parameter. MediaModality Server content modalities. Builder Builder for ContentEmbedding. ContentEmbedding The embedding generated from an input content. Builder Builder for UploadToFileSearchStoreOperation. UploadToFileSearchStoreOperation Long-running operation for uploading a file to a FileSearchStore. Builder Builder for VoiceConfig. VoiceConfig The configuration for the voice to use. Builder Builder for ExactMatchMetricValue. ExactMatchMetricValue Exact match metric value for an instance. Builder Builder for SearchTypes. SearchTypes Different types of search that can be enabled on the GoogleSearch tool. TuningMode Tuning mode. Builder Builder for DeleteCachedContentParameters. DeleteCachedContentParameters Parameters for caches.delete method. Builder Builder for GetCachedContentParameters. GetCachedContentParameters Parameters for caches.get method. Builder Builder for EditImageResponse. EditImageResponse Response for the request to edit an image. Builder Builder for GenerateVideosConfig. GenerateVideosConfig Configuration for generating videos. Builder Builder for GenerateImagesConfig. GenerateImagesConfig The config for generating an images. Builder Builder for ListBatchJobsResponse. ListBatchJobsResponse Config for batches.list return value. Builder Builder for GenerationConfigRoutingConfigManualRoutingMode. GenerationConfigRoutingConfigManualRoutingMode The configuration for manual routing. Builder Builder for SegmentImageSource. SegmentImageSource A set of source input(s) for image segmentation. VideoGenerationMaskMode Enum for the mask mode of a video generation mask. HttpElementLocation The location of the API key. Builder Builder for CustomizedAvatar. CustomizedAvatar Configures the customized avatar to be used in the session. UrlRetrievalStatus The status of the URL retrieval. Builder Builder for UpdateCachedContentConfig. UpdateCachedContentConfig Optional parameters for caches.update method. Builder Builder for PartialArg. PartialArg Partial argument value of the function call. Builder Builder for CreateTuningJobParametersPrivate. CreateTuningJobParametersPrivate Fine-tuning job creation parameters - optional fields. Builder Builder for HttpResponse. HttpResponse A wrapper class for the http response. Builder Builder for ListTuningJobsParameters. ListTuningJobsParameters Parameters for the list tuning jobs method. Builder Builder for AuthConfig. AuthConfig The authentication config to access the API. Builder Builder for UploadToFileSearchStoreConfig. UploadToFileSearchStoreConfig Optional parameters for uploading a file to a FileSearchStore. Builder Builder for WebhookConfig. WebhookConfig Configuration for webhook notifications. Builder Builder for UrlContext. UrlContext Tool to support URL context. StartSensitivity Start of speech sensitivity. Builder Builder for FunctionDeclaration. FunctionDeclaration Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Builder Builder for ModalityTokenCount. ModalityTokenCount Represents token counting info for a single modality. Builder Builder for GetBatchJobConfig. GetBatchJobConfig Optional parameters. Builder Builder for FunctionCall. FunctionCall A function call. Builder Builder for UpscaleImageResponse. UpscaleImageResponse None Builder Builder for StyleReferenceConfig. StyleReferenceConfig Configuration for a Style reference image. Builder Builder for GroundingChunkImage. GroundingChunkImage An `Image` chunk is a piece of evidence that comes from an image search result. Builder Builder for PreferenceOptimizationSpec. PreferenceOptimizationSpec Preference optimization tuning spec for tuning. Builder Builder for EvaluationDataset. EvaluationDataset The dataset used for evaluation. Builder Builder for SupervisedTuningDatasetDistributionDatasetBucket. SupervisedTuningDatasetDistributionDatasetBucket Dataset bucket used to create a histogram for the distribution given a population of values. Builder Builder for UpscaleImageAPIConfig. UpscaleImageAPIConfig Internal API config for UpscaleImage. Builder Builder for Retrieval. Retrieval Defines a retrieval tool that model can call to access external knowledge. Builder Builder for EmbedContentParametersPrivate. EmbedContentParametersPrivate Parameters for the _embed_content method. Builder Builder for ImportFileConfig. ImportFileConfig Optional parameters for importing a file. PartMediaResolutionLevel The tokenization quality used for given media. Builder Builder for FunctionCallingConfig. FunctionCallingConfig Function calling config. Builder Builder for CustomCodeExecutionSpec. CustomCodeExecutionSpec Specificies a metric that is computed by running user-defined Python functions remotely. Builder Builder for LiveClientRealtimeInput. LiveClientRealtimeInput User input that is sent in real time. Builder Builder for SingleEmbedContentResponse. SingleEmbedContentResponse Config for `response` parameter. Builder Builder for ComputerUse. ComputerUse Tool to support computer use. Builder Builder for ListModelsParameters. ListModelsParameters None Builder Builder for BleuSpec. BleuSpec Spec for bleu metric. TurnCompleteReason The reason why the turn is complete. Builder Builder for LiveServerToolCall. LiveServerToolCall Request for the client to execute the `function_calls` and return the responses with the matching `id`s. Builder Builder for LiveServerSessionResumptionUpdate. LiveServerSessionResumptionUpdate Update of the session resumption state. Modality Server content modalities. Builder Builder for RougeMetricValue. RougeMetricValue Rouge metric value for an instance. Builder Builder for GetFileConfig. GetFileConfig Used to override the default configuration. Builder Builder for ToolConfig. ToolConfig Tool config. Builder Builder for Endpoint. Endpoint An endpoint where you deploy models. Builder Builder for Segment. Segment Segment of the content this support belongs to. EmbeddingApiType Enum representing the Gemini Enterprise Agent Platform embedding API to use. Builder Builder for ImportFileParameters. ImportFileParameters Config for file_search_stores.import_file parameters. Builder Builder for Tool. Tool Tool details of a tool that the model may use to generate a response. Builder Builder for Model. Model A trained machine learning model. Builder Builder for ListTuningJobsConfig. ListTuningJobsConfig Configuration for the list tuning jobs method. Builder Builder for CancelTuningJobResponse. CancelTuningJobResponse Empty response for tunings.cancel method. Builder Builder for DistillationHyperParameters. DistillationHyperParameters Hyperparameters for distillation. Builder Builder for TuningJob. TuningJob A tuning job. Type Data type of the schema field. Builder Builder for CreateBatchJobParameters. CreateBatchJobParameters Config for batches.create parameters. Builder Builder for AuthConfigGoogleServiceAccountConfig. AuthConfigGoogleServiceAccountConfig Config for Google Service Account Authentication. Builder Builder for CitationMetadata. CitationMetadata Citation information when the model quotes another source. Builder Builder for RagRetrievalConfig. RagRetrievalConfig Specifies the context retrieval config. Builder Builder for ExternalApiSimpleSearchParams. ExternalApiSimpleSearchParams The search parameters to use for SIMPLE_SEARCH spec. TrafficType Output only. Builder Builder for GenerateVideosParameters. GenerateVideosParameters Class that represents the parameters for generating videos. VideoGenerationReferenceType Enum for the reference type of a video generation reference image. Builder Builder for ToolCodeExecution. ToolCodeExecution Tool that executes code generated by the model, and automatically returns the result to the model. FinishReason Output only. Builder Builder for Metric. Metric The metric used for evaluation. Builder Builder for PreTunedModel. PreTunedModel A pre-tuned model for continuous tuning. Builder Builder for EditImageParameters. EditImageParameters Parameters for the request to edit an image. HarmProbability Output only. Builder Builder for InlinedRequest. InlinedRequest Config for inlined request. Builder Builder for SupervisedHyperParameters. SupervisedHyperParameters Hyperparameters for SFT. Builder Builder for InternalRegisterFilesParameters. InternalRegisterFilesParameters Parameters for the private _Register method. Builder Builder for ComputeTokensParameters. ComputeTokensParameters Parameters for computing tokens. Builder Builder for LiveServerToolCallCancellation. LiveServerToolCallCancellation Notification for the client that a previously issued `ToolCallMessage` with the specified `id`s should have been not executed and should be cancelled. Builder Builder for RegisterFilesResponse. RegisterFilesResponse Response for the _register file method. SegmentMode Enum that represents the segmentation mode. Builder Builder for GenerationConfig. GenerationConfig Generation config. Builder Builder for ChunkingConfig. ChunkingConfig Config for telling the service how to chunk the file. Builder Builder for DeleteDocumentConfig. DeleteDocumentConfig Config for optional parameters. Builder Builder for BleuMetricValue. BleuMetricValue Bleu metric value for an instance. Builder Builder for UnifiedMetric. UnifiedMetric The unified metric used for evaluation. SubjectReferenceType Enum representing the subject type of a subject reference image. Builder Builder for GenerateVideosOperation. GenerateVideosOperation A video generation operation. Builder Builder for CreateEmbeddingsBatchJobConfig. CreateEmbeddingsBatchJobConfig Config for optional parameters. Builder Builder for PrebuiltVoiceConfig. PrebuiltVoiceConfig Configuration for a prebuilt voice. Builder Builder for ListModelsResponse. ListModelsResponse None Builder Builder for ModelStatus. ModelStatus The status of the underlying model. Builder Builder for BatchJobSource. BatchJobSource Config for `src` parameter. Builder Builder for GenerationConfigRoutingConfig. GenerationConfigRoutingConfig The configuration for routing the request to a specific model. ComputationBasedMetricType Represents the type of the computation based metric. Builder Builder for EnterpriseWebSearch. EnterpriseWebSearch Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. Builder Builder for VertexRagStore. VertexRagStore Retrieve from Vertex RAG Store for grounding. Builder Builder for Transcription. Transcription Audio transcription in Server Conent. Builder Builder for DeleteModelResponse. DeleteModelResponse None Builder Builder for SpeakerVoiceConfig. SpeakerVoiceConfig Configuration for a single speaker in a multi-speaker setup. Builder Builder for GroundingChunkMapsPlaceAnswerSourcesReviewSnippet. GroundingChunkMapsPlaceAnswerSourcesReviewSnippet Encapsulates a review snippet. Builder Builder for GetDocumentConfig. GetDocumentConfig Optional Config. Builder Builder for DistillationSamplingSpec. DistillationSamplingSpec Spec for creating a distilled dataset in Vertex Dataset. MediaResolution The media resolution to use. Outcome Outcome of the code execution. Builder Builder for TuningValidationDataset. TuningValidationDataset None Builder Builder for ApiAuth. ApiAuth The generic reusable api auth config. Builder Builder for LiveSendToolResponseParameters. LiveSendToolResponseParameters Parameters for sending tool responses to the live API. Builder Builder for ComputationBasedMetricSpec. ComputationBasedMetricSpec Specification for a computation based metric. Builder Builder for ListFileSearchStoresParameters. ListFileSearchStoresParameters Config for file_search_stores.list parameters. Builder Builder for CustomOutputFormatConfig. CustomOutputFormatConfig Config for custom output format. Builder Builder for GenerateContentResponsePromptFeedback. GenerateContentResponsePromptFeedback Content filter results for a prompt sent in the request. DynamicRetrievalConfigMode The mode of the predictor to be used in dynamic retrieval. Builder Builder for ComputeTokensConfig. ComputeTokensConfig Optional parameters for computing tokens. MaskReferenceMode Enum representing the mask mode of a mask reference image. Builder Builder for DeleteFileResponse. DeleteFileResponse Response for the delete file method. Builder Builder for GroundingChunkMapsRoute. GroundingChunkMapsRoute Route information from Google Maps. Builder Builder for LiveClientToolResponse. LiveClientToolResponse Client generated response to a `ToolCall` received from the server. Builder Builder for StreamableHttpTransport. StreamableHttpTransport A transport that can stream HTTP requests and responses. ResourceScope Resource scope. Builder Builder for GetModelParameters. GetModelParameters None ControlReferenceType Enum representing the control type of a control reference image. ModelRoutingPreference The model routing preference. Builder Builder for TokensInfo. TokensInfo Tokens info with a list of tokens and the corresponding list of token ids. Builder Builder for RagRetrievalConfigRankingRankService. RagRetrievalConfigRankingRankService Config for Rank Service. Builder Builder for EmbedContentMetadata. EmbedContentMetadata Request-level metadata for the Gemini Enterprise Agent Platform Embed Content API. Builder Builder for DistillationSpec. DistillationSpec Distillation tuning spec for tuning. Builder Builder for RegisterFilesConfig. RegisterFilesConfig Used to override the default configuration. Builder Builder for SupervisedTuningSpec. SupervisedTuningSpec Supervised tuning spec for tuning. Builder Builder for DeleteFileConfig. DeleteFileConfig Used to override the default configuration. Builder Builder for CreateAuthTokenParameters. CreateAuthTokenParameters Config for auth_tokens.create parameters. Builder Builder for TuningDataset. TuningDataset Supervised fine-tuning training dataset. Builder Builder for GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution. GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution Author attribution for a photo or review. Builder Builder for GenerateContentResponse. GenerateContentResponse Response message for PredictionService.GenerateContent. Builder Builder for Content. Content Contains the multi-part content of a message. Builder Builder for LLMBasedMetricSpec. LLMBasedMetricSpec Specification for an LLM based metric. Builder Builder for TuningDataStats. TuningDataStats The tuning data statistic values for TuningJob. Builder Builder for ReferenceImageAPI. ReferenceImageAPI Private class that represents a Reference image that is sent to API. Builder Builder for LatLng. LatLng An object that represents a latitude/longitude pair. Builder Builder for Citation. Citation A citation for a piece of generatedcontent. Builder Builder for CustomMetadata. CustomMetadata User provided metadata stored as key-value pairs. Builder Builder for SessionResumptionConfig. SessionResumptionConfig Configuration of session resumption mechanism. Builder Builder for UploadToFileSearchStoreResumableResponse. UploadToFileSearchStoreResumableResponse Response for the resumable upload method. Builder Builder for GenerateContentResponseUsageMetadata. GenerateContentResponseUsageMetadata Usage metadata about the content generation request and response. Builder Builder for CreateFileResponse. CreateFileResponse Response for the create file method. Builder Builder for ReplayInteraction. ReplayInteraction Represents a single interaction, request and response in a replay. HarmSeverity Output only. ModelStage The stage of the underlying model. Builder Builder for SupervisedTuningDatasetDistribution. SupervisedTuningDatasetDistribution Dataset distribution for Supervised Tuning. Builder Builder for DownloadFileConfig. DownloadFileConfig Used to override the default configuration. Builder Builder for ImportFileResponse. ImportFileResponse Response for ImportFile to import a File API file with a file search store. Builder Builder for TunedModelInfo. TunedModelInfo A tuned machine learning model. Builder Builder for CachedContent. CachedContent A resource used in LLM queries for users to explicitly specify what to cache. Builder Builder for GeneratedImageMask. GeneratedImageMask A generated image mask. Builder Builder for ListCachedContentsResponse. ListCachedContentsResponse None Builder Builder for GenerateImagesParameters. GenerateImagesParameters The parameters for generating images. Builder Builder for ApiAuthApiKeyConfig. ApiAuthApiKeyConfig The API secret. Builder Builder for ScribbleImage. ScribbleImage An image mask representing a brush scribble. Builder Builder for ListFilesParameters. ListFilesParameters Generates the parameters for the list method. Builder Builder for AvatarConfig. AvatarConfig Configures the avatar to be used in the session. Builder Builder for GroundingSupport. GroundingSupport Grounding support. Builder Builder for LogprobsResult. LogprobsResult The log probabilities of the tokens generated by the model. Builder Builder for CreateFileSearchStoreParameters. CreateFileSearchStoreParameters Config for file_search_stores.create parameters. Builder Builder for GetOperationParameters. GetOperationParameters Parameters for the GET method. Builder Builder for SegmentImageParameters. SegmentImageParameters The parameters for segmenting an image. Builder Builder for GcsSource. GcsSource The Google Cloud Storage location for the input content. Builder Builder for ListBatchJobsConfig. ListBatchJobsConfig Config for optional parameters. Builder Builder for CountTokensResponse. CountTokensResponse Response for counting tokens. Builder Builder for FetchPredictOperationConfig. FetchPredictOperationConfig None Builder Builder for RawReferenceImage. RawReferenceImage A raw reference image. Builder Builder for ToolCall. ToolCall A predicted server-side `ToolCall` returned from the model. Builder Builder for FileStatus. FileStatus Status of a File that uses a common error model. PersonGeneration Enum that controls the generation of people. Builder Builder for UpdateCachedContentParameters. UpdateCachedContentParameters None Builder Builder for CreateCachedContentParameters. CreateCachedContentParameters Parameters for caches.create method. Operation A long-running operation. Builder Builder for DeleteFileSearchStoreConfig. DeleteFileSearchStoreConfig Optional parameters for deleting a FileSearchStore. Builder Builder for LiveServerContent. LiveServerContent Incremental server update generated by the model in response to client messages. Builder Builder for LiveClientSetup. LiveClientSetup Message contains configuration that will apply for the duration of the streaming session. Builder Builder for TestTableItem. TestTableItem None Builder Builder for FunctionResponseFileData. FunctionResponseFileData URI based data for function response. Builder Builder for EditImageConfig. EditImageConfig Configuration for editing an image. Builder Builder for ComputeTokensResponse. ComputeTokensResponse Response for computing tokens. Builder Builder for TuningOperation. TuningOperation A long-running operation. Builder Builder for ListDocumentsResponse. ListDocumentsResponse Config for documents.list return value. ApiSpec The API spec that the external API implements. Builder Builder for Video. Video A generated video. Builder Builder for Image. Image An image. Builder Builder for ListTuningJobsResponse. ListTuningJobsResponse Response for the list tuning jobs method. Builder Builder for ProxyOptions. ProxyOptions Proxy configuration for the client. Builder Builder for GoogleRpcStatus. GoogleRpcStatus The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. Builder Builder for ListDocumentsConfig. ListDocumentsConfig Config for optional parameters. Builder Builder for EmbedContentParameters. EmbedContentParameters Parameters for the embed_content method. Builder Builder for GroundingChunkRetrievedContext. GroundingChunkRetrievedContext Context retrieved from a data source to ground the model's response. Builder Builder for CancelBatchJobConfig. CancelBatchJobConfig Optional parameters. Builder Builder for RagRetrievalConfigFilter. RagRetrievalConfigFilter Config for filters. Builder Builder for ActivityStart. ActivityStart Marks the start of user activity. Builder Builder for FileSearchStore. FileSearchStore A collection of Documents. Builder Builder for UploadToFileSearchStoreResponse. UploadToFileSearchStoreResponse The response when long-running operation for uploading a file to a FileSearchStore complete. Builder Builder for GetTuningJobConfig. GetTuningJobConfig Optional parameters for tunings.get method. Builder Builder for CodeExecutionResult. CodeExecutionResult Result of executing the `ExecutableCode`. Builder Builder for GeneratedImage. GeneratedImage An output image. EndSensitivity End of speech sensitivity. Builder Builder for GetBatchJobParameters. GetBatchJobParameters Config for batches.get parameters. Builder Builder for DistillationDataStats. DistillationDataStats Statistics for distillation prompt dataset. Builder Builder for StyleReferenceImage. StyleReferenceImage A style reference image. Builder Builder for BatchJob. BatchJob Config for batches.create return value. Builder Builder for DeleteBatchJobParameters. DeleteBatchJobParameters Config for batches.delete parameters. Builder Builder for ContentEmbeddingStatistics. ContentEmbeddingStatistics Statistics of the input text associated with the result of content embedding. SafetyFilterLevel Enum that controls the safety filter level for objectionable content. Builder Builder for GetOperationConfig. GetOperationConfig None Builder Builder for AutoraterConfig. AutoraterConfig Autorater config used for evaluation. Builder Builder for ListFileSearchStoresResponse. ListFileSearchStoresResponse Config for file_search_stores.list return value. Builder Builder for FunctionResponsePart. FunctionResponsePart A datatype containing media that is part of a `FunctionResponse` message. Builder Builder for LogprobsResultCandidate. LogprobsResultCandidate A single token and its associated log probability. JobState Job state. Builder Builder for SupervisedTuningDataStats. SupervisedTuningDataStats Tuning data statistics for Supervised Tuning. Builder Builder for ListFileSearchStoresConfig. ListFileSearchStoresConfig Optional parameters for listing FileSearchStore. TuningTask The tuning task. Builder Builder for ExecutableCode. ExecutableCode Model-generated code executed server-side, results returned to the model. ServiceTier Pricing and performance service tier. Builder Builder for SlidingWindow. SlidingWindow Context window will be truncated by keeping only suffix of it. Builder Builder for CreateAuthTokenConfig. CreateAuthTokenConfig Optional parameters. Builder Builder for UpdateModelParameters. UpdateModelParameters Configuration for updating a tuned model. Builder Builder for CompletionStats. CompletionStats Success and error statistics of processing multiple entities (for example, DataItems or structured data rows) in batch. Builder Builder for AudioTranscriptionConfig. AudioTranscriptionConfig The audio transcription configuration in Setup. Builder Builder for GetTuningJobParameters. GetTuningJobParameters Parameters for the get method. Builder Builder for EmbedContentResponse. EmbedContentResponse Response for the embed_content method. Builder Builder for ListBatchJobsParameters. ListBatchJobsParameters Config for batches.list parameters. Builder Builder for FileData. FileData URI-based data. Builder Builder for ReplicatedVoiceConfig. ReplicatedVoiceConfig The configuration for the replicated voice to use. Builder Builder for RecontextImageParameters. RecontextImageParameters The parameters for recontextualizing an image. Builder Builder for ComputeTokensResult. ComputeTokensResult Local tokenizer compute tokens result. Builder Builder for AuthConfigHttpBasicAuthConfig. AuthConfigHttpBasicAuthConfig Config for HTTP Basic Authentication. Builder Builder for RecontextImageSource. RecontextImageSource A set of source input(s) for image recontextualization. Builder Builder for VeoTuningSpec. VeoTuningSpec Tuning Spec for Veo Model Tuning. Builder Builder for PairwiseMetricResult. PairwiseMetricResult Spec for pairwise metric result. Builder Builder for DeleteCachedContentConfig. DeleteCachedContentConfig Optional parameters for caches.delete method. Builder Builder for DatasetDistribution. DatasetDistribution Distribution computed over a tuning dataset. Builder Builder for GenerateContentParameters. GenerateContentParameters Config for models.generate_content parameters. Builder Builder for VertexAISearchDataStoreSpec. VertexAISearchDataStoreSpec Define data stores within engine to filter on in a search call and configurations for those data stores. Builder Builder for LiveServerMessage. LiveServerMessage Response message for API call. Builder Builder for TuningExample. TuningExample A single example for tuning. Builder Builder for LiveClientContent. LiveClientContent Incremental update of the current conversation delivered from the client. Builder Builder for HttpRetryOptions. HttpRetryOptions HTTP retry options to be used in each of the requests. Builder Builder for PartMediaResolution. PartMediaResolution Media resolution for the input media. Builder Builder for VoiceActivity. VoiceActivity Voice activity signal. Builder Builder for ContextWindowCompressionConfig. ContextWindowCompressionConfig Enables context window compression -- mechanism managing model context window so it does not exceed given length. Builder Builder for GetModelConfig. GetModelConfig Optional parameters for models.get method. Builder Builder for LiveConnectConstraints. LiveConnectConstraints Config for LiveConnectConstraints for Auth Token creation. Builder Builder for GenerateVideosResponse. GenerateVideosResponse Response with generated videos. Builder Builder for GetFileParameters. GetFileParameters Generates the parameters for the get method. Builder Builder for LiveConnectParameters. LiveConnectParameters Parameters for connecting to the live API. VoiceActivityType The type of the voice activity signal. Builder Builder for MaskReferenceConfig. MaskReferenceConfig Configuration for a Mask reference image. Builder Builder for CreateTuningJobConfig. CreateTuningJobConfig Fine-tuning job creation request - optional fields. Builder Builder for RawOutput. RawOutput Raw output. Builder Builder for PredefinedMetricSpec. PredefinedMetricSpec The spec for a pre-defined metric. Builder Builder for GroundingChunk. GroundingChunk A piece of evidence that supports a claim made by the model. Builder Builder for GoogleSearch. GoogleSearch GoogleSearch tool type. Builder Builder for Schema. Schema Schema is used to define the format of input/output data. Builder Builder for ImageConfigImageOutputOptions. ImageConfigImageOutputOptions The image output format for generated images. RubricContentType The type of rubric content to be generated. Builder Builder for EvaluateDatasetResponse. EvaluateDatasetResponse The results from an evaluation run performed by the EvaluationService. Builder Builder for RougeSpec. RougeSpec Spec for rouge metric. Builder Builder for CreateBatchJobConfig. CreateBatchJobConfig Config for optional parameters. Builder Builder for VeoHyperParameters. VeoHyperParameters Hyperparameters for Veo. PhishBlockThreshold Sites with confidence level chosen &above this value will be blocked from the search results. Builder Builder for MaskReferenceImage. MaskReferenceImage A mask reference image. Builder Builder for DatasetStats. DatasetStats Statistics computed over a tuning dataset. Builder Builder for AuthConfigOauthConfig. AuthConfigOauthConfig Config for user oauth. TuningJobState Output only. Language Programming language of the `code`. -
Enum Summary Enum Description Known Enum representing the known values for ProminentPeople. Known Enum representing the known values for ToolType. Known Enum representing the known values for FeatureSelectionPreference. Known Enum representing the known values for AggregationMetric. Known Enum representing the known values for DocumentState. Known Enum representing the known values for BlockedReason. Known Enum representing the known values for EditMode. Known Enum representing the known values for ProxyType. Known Enum representing the known values for Environment. Known Enum representing the known values for VadSignalType. Known Enum representing the known values for FunctionCallingConfigMode. Known Enum representing the known values for FileState. Known Enum representing the known values for ActivityHandling. Known Enum representing the known values for FileSource. Known Enum representing the known values for PairwiseChoice. Known Enum representing the known values for ThinkingLevel. Known Enum representing the known values for AdapterSize. Known Enum representing the known values for Behavior. Known Enum representing the known values for AuthType. Known Enum representing the known values for HarmBlockThreshold. Known Enum representing the known values for TurnCoverage. Known Enum representing the known values for HarmBlockMethod. Known Enum representing the known values for FunctionResponseScheduling. Known Enum representing the known values for TuningMethod. Known Enum representing the known values for ImagePromptLanguage. Known Enum representing the known values for HarmCategory. Known Enum representing the known values for VideoCompressionQuality. Known Enum representing the known values for NullValue. Known Enum representing the known values for MediaModality. Known Enum representing the known values for TuningMode. Known Enum representing the known values for VideoGenerationMaskMode. Known Enum representing the known values for HttpElementLocation. Known Enum representing the known values for UrlRetrievalStatus. Known Enum representing the known values for StartSensitivity. Known Enum representing the known values for PartMediaResolutionLevel. Known Enum representing the known values for TurnCompleteReason. Known Enum representing the known values for Modality. Known Enum representing the known values for EmbeddingApiType. Known Enum representing the known values for Type. Known Enum representing the known values for TrafficType. Known Enum representing the known values for VideoGenerationReferenceType. Known Enum representing the known values for FinishReason. Known Enum representing the known values for HarmProbability. Known Enum representing the known values for SegmentMode. Known Enum representing the known values for SubjectReferenceType. Known Enum representing the known values for ComputationBasedMetricType. Known Enum representing the known values for MediaResolution. Known Enum representing the known values for Outcome. Known Enum representing the known values for DynamicRetrievalConfigMode. Known Enum representing the known values for MaskReferenceMode. Known Enum representing the known values for ResourceScope. Known Enum representing the known values for ControlReferenceType. Known Enum representing the known values for ModelRoutingPreference. Known Enum representing the known values for HarmSeverity. Known Enum representing the known values for ModelStage. Known Enum representing the known values for PersonGeneration. Known Enum representing the known values for ApiSpec. Known Enum representing the known values for EndSensitivity. Known Enum representing the known values for SafetyFilterLevel. Known Enum representing the known values for JobState. Known Enum representing the known values for TuningTask. Known Enum representing the known values for ServiceTier. Known Enum representing the known values for VoiceActivityType. Known Enum representing the known values for RubricContentType. Known Enum representing the known values for PhishBlockThreshold. Known Enum representing the known values for TuningJobState. Known Enum representing the known values for Language. -
Interface Summary Interface Description ReferenceImage An interface for a Reference image.