Namespace Google.Apis.FirebaseML.v2beta.Data

Classes

Date

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp

GoogleCloudAiplatformV1beta1ApiAuth

The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead.

GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig

The API secret.

GoogleCloudAiplatformV1beta1AuthConfig

Auth configuration to run the extension.

GoogleCloudAiplatformV1beta1AuthConfigApiKeyConfig

Config for authentication with API key.

GoogleCloudAiplatformV1beta1AuthConfigGoogleServiceAccountConfig

Config for Google Service Account Authentication.

GoogleCloudAiplatformV1beta1AuthConfigHttpBasicAuthConfig

Config for HTTP Basic Authentication.

GoogleCloudAiplatformV1beta1AuthConfigOauthConfig

Config for user oauth.

GoogleCloudAiplatformV1beta1AuthConfigOidcConfig

Config for user OIDC auth.

GoogleCloudAiplatformV1beta1Blob

A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video.

GoogleCloudAiplatformV1beta1Candidate

A response candidate generated from the model.

GoogleCloudAiplatformV1beta1Citation

A citation for a piece of generatedcontent.

GoogleCloudAiplatformV1beta1CitationMetadata

A collection of citations that apply to a piece of generated content.

GoogleCloudAiplatformV1beta1CodeExecutionResult

Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a part containing the [ExecutableCode].

GoogleCloudAiplatformV1beta1Content

The structured data content of a message. A Content message contains a role field, which indicates the producer of the content, and a parts field, which contains the multi-part data of the message.

GoogleCloudAiplatformV1beta1CountTokensRequest

Request message for PredictionService.CountTokens.

GoogleCloudAiplatformV1beta1CountTokensResponse

Response message for PredictionService.CountTokens.

GoogleCloudAiplatformV1beta1DynamicRetrievalConfig

Describes the options to customize dynamic retrieval.

GoogleCloudAiplatformV1beta1EnterpriseWebSearch

Tool to search public web data, powered by Vertex AI Search and Sec4 compliance.

GoogleCloudAiplatformV1beta1ExecutableCode

Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated.

GoogleCloudAiplatformV1beta1ExternalApi

Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec.

GoogleCloudAiplatformV1beta1ExternalApiElasticSearchParams

The search parameters to use for the ELASTIC_SEARCH spec.

GoogleCloudAiplatformV1beta1ExternalApiSimpleSearchParams

The search parameters to use for SIMPLE_SEARCH spec.

GoogleCloudAiplatformV1beta1FileData

URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage.

GoogleCloudAiplatformV1beta1FunctionCall

A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values.

GoogleCloudAiplatformV1beta1FunctionCallingConfig

Function calling config.

GoogleCloudAiplatformV1beta1FunctionDeclaration

Structured representation of a function declaration as defined by the OpenAPI 3.0 specification. Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a Tool by the model and executed by the client.

GoogleCloudAiplatformV1beta1FunctionResponse

The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction.

GoogleCloudAiplatformV1beta1FunctionResponseBlob

Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field.

GoogleCloudAiplatformV1beta1FunctionResponseFileData

URI based data for function response.

GoogleCloudAiplatformV1beta1FunctionResponsePart

A datatype containing media that is part of a FunctionResponse message. A FunctionResponsePart consists of data which has an associated datatype. A FunctionResponsePart can only contain one of the accepted types in FunctionResponsePart.data. A FunctionResponsePart must have a fixed IANA MIME type identifying the type and subtype of the media if the inline_data field is filled with raw bytes.

GoogleCloudAiplatformV1beta1GenerateContentRequest

Request message for [PredictionService.GenerateContent].

GoogleCloudAiplatformV1beta1GenerateContentResponse

Response message for [PredictionService.GenerateContent].

GoogleCloudAiplatformV1beta1GenerateContentResponsePromptFeedback

Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations.

GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata

Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics.

GoogleCloudAiplatformV1beta1GenerationConfig

Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output.

GoogleCloudAiplatformV1beta1GenerationConfigModelConfig

Config for model selection.

GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig

The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name.

GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode

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

GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode

The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided.

GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig

Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response.

GoogleCloudAiplatformV1beta1GoogleMaps

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

GoogleCloudAiplatformV1beta1GoogleSearchRetrieval

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

GoogleCloudAiplatformV1beta1GroundingChunk

A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a GroundingChunk that contains a reference to the source of the information.

GoogleCloudAiplatformV1beta1GroundingChunkMaps

A Maps chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information.

GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources

The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content.

GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet

A review snippet that is used to generate the answer.

GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext

Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset.

GoogleCloudAiplatformV1beta1GroundingChunkWeb

A Web chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information.

GoogleCloudAiplatformV1beta1GroundingMetadata

Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources.

GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri

A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps.

GoogleCloudAiplatformV1beta1GroundingSupport

A collection of supporting references for a segment of the model's response.

GoogleCloudAiplatformV1beta1ImageConfig

Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people.

GoogleCloudAiplatformV1beta1ImageConfigImageOutputOptions

The image output format for generated images.

GoogleCloudAiplatformV1beta1LogprobsResult

The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is "hallucinating" or generating factually incorrect information.

GoogleCloudAiplatformV1beta1LogprobsResultCandidate

A single token and its associated log probability.

GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates

A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered.

GoogleCloudAiplatformV1beta1ModalityTokenCount

Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.

GoogleCloudAiplatformV1beta1ModelArmorConfig

Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks.

GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig

Configuration for a multi-speaker text-to-speech request.

GoogleCloudAiplatformV1beta1Part

A datatype containing media that is part of a multi-part Content message. A Part consists of data which has an associated datatype. A Part can only contain one of the accepted types in Part.data. For media types that are not text, Part must have a fixed IANA MIME type identifying the type and subtype of the media if inline_data or file_data field is filled with raw bytes.

GoogleCloudAiplatformV1beta1PartMediaResolution

per part media resolution. Media resolution for the input media.

GoogleCloudAiplatformV1beta1PartialArg

Partial argument value of the function call.

GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig

Configuration for a prebuilt voice.

GoogleCloudAiplatformV1beta1RagChunk

A RagChunk includes the content of a chunk of a RagFile, and associated metadata.

GoogleCloudAiplatformV1beta1RagChunkPageSpan

Represents where the chunk starts and ends in the document.

GoogleCloudAiplatformV1beta1RagRetrievalConfig

Specifies the context retrieval config.

GoogleCloudAiplatformV1beta1RagRetrievalConfigFilter

Config for filters.

GoogleCloudAiplatformV1beta1RagRetrievalConfigHybridSearch

Config for Hybrid Search.

GoogleCloudAiplatformV1beta1RagRetrievalConfigRanking

Config for ranking and reranking.

GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingLlmRanker

Config for LlmRanker.

GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingRankService

Config for Rank Service.

GoogleCloudAiplatformV1beta1ReplicatedVoiceConfig

The configuration for the replicated voice to use.

GoogleCloudAiplatformV1beta1Retrieval

Defines a retrieval tool that model can call to access external knowledge.

GoogleCloudAiplatformV1beta1RetrievalConfig

Retrieval config.

GoogleCloudAiplatformV1beta1RetrievalMetadata

Metadata related to the retrieval grounding source. This is part of the GroundingMetadata returned when grounding is enabled.

GoogleCloudAiplatformV1beta1SafetyRating

A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level.

GoogleCloudAiplatformV1beta1SafetySetting

A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.

GoogleCloudAiplatformV1beta1Schema

Schema is used to define the format of input/output data. Represents a select subset of an OpenAPI 3.0 schema object. More fields may be added in the future as needed.

GoogleCloudAiplatformV1beta1SearchEntryPoint

An entry point for displaying Google Search results. A SearchEntryPoint is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application.

GoogleCloudAiplatformV1beta1Segment

A segment of the content.

GoogleCloudAiplatformV1beta1SpeakerVoiceConfig

Configuration for a single speaker in a multi-speaker setup.

GoogleCloudAiplatformV1beta1SpeechConfig

Configuration for speech generation.

GoogleCloudAiplatformV1beta1Tool

Tool details that the model may use to generate response. A Tool is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).

GoogleCloudAiplatformV1beta1ToolCodeExecution

Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool.

GoogleCloudAiplatformV1beta1ToolComputerUse

Tool to support computer use.

GoogleCloudAiplatformV1beta1ToolConfig

Tool config. This config is shared for all tools provided in the request.

GoogleCloudAiplatformV1beta1ToolGoogleSearch

GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.

GoogleCloudAiplatformV1beta1UrlContext

Tool to support URL context.

GoogleCloudAiplatformV1beta1UrlContextMetadata

Metadata returned when the model uses the url_context tool to get information from a user-provided URL.

GoogleCloudAiplatformV1beta1UrlMetadata

The metadata for a single URL retrieval.

GoogleCloudAiplatformV1beta1VertexAISearch

Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder

GoogleCloudAiplatformV1beta1VertexAISearchDataStoreSpec

Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec

GoogleCloudAiplatformV1beta1VertexRagStore

Retrieve from Vertex RAG Store for grounding.

GoogleCloudAiplatformV1beta1VertexRagStoreRagResource

The definition of the Rag resource.

GoogleCloudAiplatformV1beta1VideoMetadata

Provides metadata for a video, including the start and end offsets for clipping and the frame rate.

GoogleCloudAiplatformV1beta1VoiceConfig

Configuration for a voice.

LatLng

An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.

ModelOperationMetadata

This is returned in the longrunning operations for create/update.