google-genai/com.google.genai.types

Package-level declarations

Types used in the Google GenAI SDK.

Types

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