GET
/v1/schemas/google-vertex/chat/v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent
Accept:
| field | recorded source |
|---|---|
| schema | Source linked above. upstream-spec Source tracef9413676dbb54b8b29ad6c14775577ea9f2b110832cba13c0808e5061701cd16{
"fetchedAt": 1794029437,
"extractorVersion": "1",
"verifiedAt": null
} |
Request body
11 properties · 0 required · 86 $defs| property | type | description | constraints |
|---|---|---|---|
| labels | object | Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, … | |
| generationConfig | GoogleCloudAiplatformV1GenerationConfig | 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. | |
| toolConfig | GoogleCloudAiplatformV1ToolConfig | Tool config. This config is shared for all tools provided in the request. | |
| contents | GoogleCloudAiplatformV1Content[] | Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. | |
| cachedContent | string | Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locatio… | |
| systemInstruction | GoogleCloudAiplatformV1Content | 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. | |
| modelArmorConfig | GoogleCloudAiplatformV1ModelArmorConfig | 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 a… | |
| continuationToken | string | Optional. An opaque continuation token used to resume generation from a previous `GenerateContent` or `StreamGenerateContent` response that stopped with `finish_reason` set to `CONTINUATION`. | format: byte |
| outputConfig | GoogleCloudAiplatformV1GenerateContentRequestOutputConfig | Configuration for persisting output assets to external storage. | |
| safetySettings | GoogleCloudAiplatformV1SafetySetting[] | Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. | |
| tools | GoogleCloudAiplatformV1Tool[] | Optional. A list of `Tools` the model may use to generate the next 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. |
Types
86 $defsGoogleCloudAiplatformV1ApiAuthobject
The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead.
| apiKeyConfig | GoogleCloudAiplatformV1ApiAuthApiKeyConfig | The API secret. |
GoogleCloudAiplatformV1ApiAuthApiKeyConfigobject
The API secret.
| apiKeyString | string | The API key string. Either this or `api_key_secret_version` must be set. | |
| apiKeySecretVersion | string | Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} |
GoogleCloudAiplatformV1AudioResponseFormatobject
Configuration for audio-specific output formatting.
| bitRate | integer | Optional. Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). | format: int32 |
| delivery | enum | Optional. Delivery mode for the generated content. | DELIVERY_UNSPECIFIED | INLINE | URI |
| sampleRate | integer | Optional. Sample rate for the generated audio in Hertz. | format: int32 |
| mimeType | enum | Optional. The MIME type of the audio output. | MIME_TYPE_UNSPECIFIED | AUDIO_MP3 | AUDIO_OGG_OPUS | AUDIO_L16 | AUDIO_WAV | AUDIO_ALAW · +1 more |
GoogleCloudAiplatformV1AudioTranscriptionobject
The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate `Part` with its own `AudioTranscription` carrying the `speaker_label`.
| text | string | Required. The transcription text of this audio segment. | |
| speakerLabel | string | Optional. A label identifying the speaker of this audio segment (e.g. `spk_1`, `spk_2`). Present when `diarization` is set. | |
| words | GoogleCloudAiplatformV1AudioTranscriptionWordInfo[] | Optional. Detailed word-level transcriptions and timing details. Present when `word_timestamp` is set. |
GoogleCloudAiplatformV1AudioTranscriptionConfigobject
Configuration for speech recognition (transcription).
| languageCodes | string[] | Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to automatic language detection. | |
| mode | enum | Optional. Configures transcription mode. Supported values: `VERBATIM`, `SMART`. If unspecified, defaults to `VERBATIM` transcription. In `SMART` mode, the model performs disfluency removal (eliminating filler words, repetitions, and false starts), light gramma… | MODE_UNSPECIFIED | VERBATIM | SMART |
| languageHints | GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageHints | Deprecated: Use top-level `language_codes` instead. Provides hints to the model about possible languages present in the audio. | |
| wordTimestamp | boolean | Optional. Configures word-level timestamp generation. | |
| adaptationPhrases | string[] | Optional. Deprecated: Use `custom_vocabulary` instead. A list of phrases to bias the speech recognition model towards. | |
| customVocabulary | string[] | Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. | |
| languageAuto | GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageAuto | Deprecated: Use top-level `language_codes` instead. Indicates the language of the audio should be automatically detected. | |
| diarization | boolean | Optional. Configures speaker diarization. | |
| sourceText | string | Optional. The source text to be edited or rewritten via voice instructions. When provided in `SMART` mode, the model evaluates the audio input against this text and emits the complete replacement text in the candidate response rather than appending to it. |
GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageAutoobject
Deprecated: Use top-level `language_codes` instead. Indicates the language of the audio should be automatically detected.
GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageHintsobject
Deprecated: Use top-level `language_codes` instead. Provides hints to the model about possible languages present in the audio.
| languageCodes | string[] | Required. Deprecated: Use top-level `language_codes` instead. BCP-47 language codes. At least one must be specified. |
GoogleCloudAiplatformV1AudioTranscriptionWordInfoobject
Information about a single recognized word.
| endOffset | string | Optional. End offset in time of the word relative to the start of the audio. | format: google-duration |
| startOffset | string | Optional. Start offset in time of the word relative to the start of the audio. | format: google-duration |
| word | string | Required. Transcript of the word. |
GoogleCloudAiplatformV1AuthConfigobject
Auth configuration to run the extension.
| googleServiceAccountConfig | GoogleCloudAiplatformV1AuthConfigGoogleServiceAccountConfig | Config for Google Service Account Authentication. | |
| apiKeyConfig | GoogleCloudAiplatformV1AuthConfigApiKeyConfig | Config for authentication with API key. | |
| httpBasicAuthConfig | GoogleCloudAiplatformV1AuthConfigHttpBasicAuthConfig | Config for HTTP Basic Authentication. | |
| authType | enum | Type of auth scheme. | AUTH_TYPE_UNSPECIFIED | NO_AUTH | API_KEY_AUTH | HTTP_BASIC_AUTH | GOOGLE_SERVICE_ACCOUNT_AUTH | OAUTH · +1 more |
| oauthConfig | GoogleCloudAiplatformV1AuthConfigOauthConfig | Config for user oauth. | |
| oidcConfig | GoogleCloudAiplatformV1AuthConfigOidcConfig | Config for user OIDC auth. |
GoogleCloudAiplatformV1AuthConfigApiKeyConfigobject
Config for authentication with API key.
| apiKeySecret | string | Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_stri… | |
| apiKeyString | string | Optional. The API key to be used in the request directly. | |
| httpElementLocation | enum | Optional. The location of the API key. | HTTP_IN_UNSPECIFIED | HTTP_IN_QUERY | HTTP_IN_HEADER | HTTP_IN_PATH | HTTP_IN_BODY | HTTP_IN_COOKIE |
| name | string | Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. |
GoogleCloudAiplatformV1AuthConfigGoogleServiceAccountConfigobject
Config for Google Service Account Authentication.
| serviceAccount | string | Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/do… |
GoogleCloudAiplatformV1AuthConfigHttpBasicAuthConfigobject
Config for HTTP Basic Authentication.
| credentialSecret | string | Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex… |
GoogleCloudAiplatformV1AuthConfigOauthConfigobject
Config for user oauth.
| serviceAccount | string | The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-a… | |
| accessToken | string | Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. |
GoogleCloudAiplatformV1AuthConfigOidcConfigobject
Config for user OIDC auth.
| serviceAccount | string | The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - … | |
| idToken | string | OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. |
GoogleCloudAiplatformV1Blobobject
A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video.
| displayName | string | Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search… | |
| mimeType | string | Required. The IANA standard MIME type of the source data. | |
| data | string | Required. The raw bytes of the data. | format: byte |
GoogleCloudAiplatformV1CodeExecutionResultobject
Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used.
| output | string | Optional. Contains stdout when code execution is successful, stderr or other description otherwise. | |
| outcome | enum | Required. Outcome of the code execution. | OUTCOME_UNSPECIFIED | OUTCOME_OK | OUTCOME_FAILED | OUTCOME_DEADLINE_EXCEEDED |
| id | string | Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. |
GoogleCloudAiplatformV1Contentobject
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.
| parts | GoogleCloudAiplatformV1Part[] | Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. | |
| role | string | Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. |
GoogleCloudAiplatformV1DynamicRetrievalConfigobject
Describes the options to customize dynamic retrieval.
| mode | enum | The mode of the predictor to be used in dynamic retrieval. | MODE_UNSPECIFIED | MODE_DYNAMIC |
| dynamicThreshold | number | Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. | format: float |
GoogleCloudAiplatformV1EnterpriseWebSearchobject
Tool to search public web data, powered by Vertex AI Search and Sec4 compliance.
| excludeDomains | string[] | Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. | |
| blockingConfidence | enum | Optional. Sites with confidence level chosen & above this value will be blocked from the search results. | PHISH_BLOCK_THRESHOLD_UNSPECIFI… | BLOCK_LOW_AND_ABOVE | BLOCK_MEDIUM_AND_ABOVE | BLOCK_HIGH_AND_ABOVE | BLOCK_HIGHER_AND_ABOVE | BLOCK_VERY_HIGH_AND_ABOVE · +1 more |
GoogleCloudAiplatformV1ExecutableCodeobject
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.
| language | enum | Required. Programming language of the `code`. | LANGUAGE_UNSPECIFIED | PYTHON |
| code | string | Required. The code to be executed. | |
| id | string | Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. |
GoogleCloudAiplatformV1ExternalApiobject
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.
| simpleSearchParams | GoogleCloudAiplatformV1ExternalApiSimpleSearchParams | The search parameters to use for SIMPLE_SEARCH spec. | |
| authConfig | GoogleCloudAiplatformV1AuthConfig | Auth configuration to run the extension. | |
| apiAuth | GoogleCloudAiplatformV1ApiAuth | The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. | |
| elasticSearchParams | GoogleCloudAiplatformV1ExternalApiElasticSearchParams | The search parameters to use for the ELASTIC_SEARCH spec. | |
| endpoint | string | The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search | |
| apiSpec | enum | The API spec that the external API implements. | API_SPEC_UNSPECIFIED | SIMPLE_SEARCH | ELASTIC_SEARCH |
GoogleCloudAiplatformV1ExternalApiElasticSearchParamsobject
The search parameters to use for the ELASTIC_SEARCH spec.
| searchTemplate | string | The ElasticSearch search template to use. | |
| index | string | The ElasticSearch index to use. | |
| numHits | integer | Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. | format: int32 |
GoogleCloudAiplatformV1ExternalApiSimpleSearchParamsobject
The search parameters to use for SIMPLE_SEARCH spec.
GoogleCloudAiplatformV1FileDataobject
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.
| mimeType | string | Required. The IANA standard MIME type of the source data. | |
| displayName | string | Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search… | |
| fileUri | string | Required. The URI of the file in Google Cloud Storage. |
GoogleCloudAiplatformV1FunctionCallobject
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.
| name | string | Optional. The name of the function to call. Matches FunctionDeclaration.name. | |
| args | object | Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. | |
| willContinue | boolean | Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. | |
| partialArgs | GoogleCloudAiplatformV1PartialArg[] | Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. | |
| id | string | Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. |
GoogleCloudAiplatformV1FunctionCallingConfigobject
Function calling config.
| mode | enum | Optional. Function calling mode. | MODE_UNSPECIFIED | AUTO | ANY | NONE | VALIDATED |
| allowedFunctionNames | string[] | Optional. Function names to call. Only set when the Mode is ANY. Function names should match FunctionDeclaration.name. With mode set to ANY, model will predict a function call from the set of function names provided. | |
| streamFunctionCallArguments | boolean | Optional. When set to true, arguments of a single function call will be streamed out in multiple parts/contents/responses. Partial parameter results will be returned in the `FunctionCall.partial_args` field. |
GoogleCloudAiplatformV1FunctionDeclarationobject
Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is …
| parametersJsonSchema | any | Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "t… | |
| responseJsonSchema | any | Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. | |
| response | GoogleCloudAiplatformV1Schema | Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). | |
| behavior | enum | Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. | UNSPECIFIED | BLOCKING | NON_BLOCKING |
| description | string | Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. | |
| name | string | Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. | |
| parameters | GoogleCloudAiplatformV1Schema | Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). |
GoogleCloudAiplatformV1FunctionResponseobject
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…
| parts | GoogleCloudAiplatformV1FunctionResponsePart[] | Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. | |
| name | string | Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. | |
| id | string | Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. | |
| response | object | Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. | |
| scheduling | enum | Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. | SCHEDULING_UNSPECIFIED | SILENT | WHEN_IDLE | INTERRUPT |
GoogleCloudAiplatformV1FunctionResponseBlobobject
Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field.
| data | string | Required. Raw bytes. | format: byte |
| mimeType | string | Required. The IANA standard MIME type of the source data. | |
| displayName | string | Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_executi… |
GoogleCloudAiplatformV1FunctionResponseFileDataobject
URI based data for function response.
| fileUri | string | Required. URI. | |
| displayName | string | Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (co… | |
| mimeType | string | Required. The IANA standard MIME type of the source data. |
GoogleCloudAiplatformV1FunctionResponsePartobject
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 `Functio…
| fileData | GoogleCloudAiplatformV1FunctionResponseFileData | URI based data for function response. | |
| inlineData | GoogleCloudAiplatformV1FunctionResponseBlob | Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. |
GoogleCloudAiplatformV1GenerateContentRequestOutputConfigobject
Configuration for persisting output assets to external storage.
| outputUriPrefix | string | Optional. The Cloud Storage URI prefix or directory where generated media assets should be written (e.g. `gs://my-bucket/prefix/`). Supported URI schemes: `gs://`. When set, media bytes are written directly to this location and returned as `FileData` with a `f… |
GoogleCloudAiplatformV1GenerationConfigobject
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.
| responseMimeType | string | Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response typ… | |
| responseModalities | enum[] | Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. | |
| imageConfig | GoogleCloudAiplatformV1ImageConfig | 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. | |
| enableAffectiveDialog | boolean | Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. | |
| seed | integer | Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not… | format: int32 |
| responseJsonSchema | any | Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. Deprecated: Use `response_format` instead. | |
| responseLogprobs | boolean | Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be u… | |
| responseSchema | GoogleCloudAiplatformV1Schema | Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). | |
| temperature | number | Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. | format: float |
| maxOutputTokens | integer | Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. | format: int32 |
| audioTimestamp | boolean | Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. | |
| mediaResolution | enum | Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail… | MEDIA_RESOLUTION_UNSPECIFIED | MEDIA_RESOLUTION_LOW | MEDIA_RESOLUTION_MEDIUM | MEDIA_RESOLUTION_HIGH |
| topP | number | Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the mo… | format: float |
| candidateCount | integer | Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. | format: int32 |
| thinkingConfig | GoogleCloudAiplatformV1GenerationConfigThinkingConfig | 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-quali… | |
| topK | number | Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the nex… | format: float |
| routingConfig | GoogleCloudAiplatformV1GenerationConfigRoutingConfig | 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. | |
| translationConfig | GoogleCloudAiplatformV1TranslationConfig | Config for translation features. | |
| audioTranscriptionConfig | GoogleCloudAiplatformV1AudioTranscriptionConfig | Configuration for speech recognition (transcription). | |
| logprobs | integer | Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the respon… | format: int32 |
| responseFormat | GoogleCloudAiplatformV1ResponseFormat[] | Optional. New response format field for the model to configure output formatting and delivery. | |
| presencePenalty | number | Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. | format: float |
| frequencyPenalty | number | Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. | format: float |
| speechConfig | GoogleCloudAiplatformV1SpeechConfig | Configuration for speech generation. | |
| stopSequences | string[] | Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use… |
GoogleCloudAiplatformV1GenerationConfigRoutingConfigobject
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.
| autoMode | GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode | 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. | |
| manualMode | GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode | The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. |
GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingModeobject
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.
| modelRoutingPreference | enum | The model routing preference. | UNKNOWN | PRIORITIZE_QUALITY | BALANCED | PRIORITIZE_COST |
GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingModeobject
The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided.
| modelName | string | The name of the model to use. Only public LLM models are accepted. |
GoogleCloudAiplatformV1GenerationConfigThinkingConfigobject
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-quali…
| includeThoughts | boolean | Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true… | |
| thinkingLevel | enum | Optional. The number of thoughts tokens that the model should generate. | THINKING_LEVEL_UNSPECIFIED | LOW | MEDIUM | HIGH | MINIMAL |
| thinkingBudget | integer | Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. | format: int32 |
GoogleCloudAiplatformV1GoogleMapsobject
Tool to retrieve public maps data for grounding, powered by Google.
| enableWidget | boolean | Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. | |
| groundingTypes | GoogleCloudAiplatformV1GoogleMapsGroundingTypes | Defines the types of Google Maps grounding that can be enabled and their configurations. |
GoogleCloudAiplatformV1GoogleMapsGroundingTypesobject
Defines the types of Google Maps grounding that can be enabled and their configurations.
| places | GoogleCloudAiplatformV1GoogleMapsPlaces | Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. | |
| routing | GoogleCloudAiplatformV1GoogleMapsRouting | Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). |
GoogleCloudAiplatformV1GoogleMapsPlacesobject
Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified.
GoogleCloudAiplatformV1GoogleMapsRoutingobject
Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute).
GoogleCloudAiplatformV1GoogleSearchRetrievalobject
Tool to retrieve public web data for grounding, powered by Google.
| dynamicRetrievalConfig | GoogleCloudAiplatformV1DynamicRetrievalConfig | Describes the options to customize dynamic retrieval. |
GoogleCloudAiplatformV1ImageConfigobject
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.
| imageSize | string | Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. | |
| aspectRatio | string | Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" | |
| imageOutputOptions | GoogleCloudAiplatformV1ImageConfigImageOutputOptions | The image output format for generated images. | |
| prominentPeople | enum | Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecifie… | PROMINENT_PEOPLE_UNSPECIFIED | ALLOW_PROMINENT_PEOPLE | BLOCK_PROMINENT_PEOPLE |
| personGeneration | enum | Optional. Controls whether the model can generate people. | PERSON_GENERATION_UNSPECIFIED | ALLOW_ALL | ALLOW_ADULT | ALLOW_NONE |
GoogleCloudAiplatformV1ImageConfigImageOutputOptionsobject
The image output format for generated images.
| mimeType | string | Optional. The image format that the output should be saved as. | |
| compressionQuality | integer | Optional. The compression quality of the output image. | format: int32 |
GoogleCloudAiplatformV1ImageResponseFormatobject
Configuration for image-specific output formatting.
| mimeType | enum | Optional. The MIME type of the image output. | MIME_TYPE_UNSPECIFIED | IMAGE_JPEG |
| imageSize | enum | Optional. The size of the image output. | IMAGE_SIZE_UNSPECIFIED | IMAGE_SIZE_FIVE_TWELVE | IMAGE_SIZE_ONE_K | IMAGE_SIZE_TWO_K | IMAGE_SIZE_FOUR_K |
| delivery | enum | Optional. Delivery mode for the generated content. | DELIVERY_UNSPECIFIED | INLINE | URI |
| aspectRatio | enum | Optional. The aspect ratio for the image output. | ASPECT_RATIO_UNSPECIFIED | ASPECT_RATIO_ONE_BY_ONE | ASPECT_RATIO_TWO_BY_THREE | ASPECT_RATIO_THREE_BY_TWO | ASPECT_RATIO_THREE_BY_FOUR | ASPECT_RATIO_FOUR_BY_THREE · +9 more |
GoogleCloudAiplatformV1ModelArmorConfigobject
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 a…
| promptTemplateName | string | Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the… | |
| responseTemplateName | string | Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check t… |
GoogleCloudAiplatformV1MultiSpeakerVoiceConfigobject
Configuration for a multi-speaker text-to-speech request.
| speakerVoiceConfigs | GoogleCloudAiplatformV1SpeakerVoiceConfig[] | Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. |
GoogleCloudAiplatformV1Partobject
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` must contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IA…
| executableCode | GoogleCloudAiplatformV1ExecutableCode | 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. | |
| functionResponse | GoogleCloudAiplatformV1FunctionResponse | 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… | |
| mediaResolution | GoogleCloudAiplatformV1PartMediaResolution | per part media resolution. Media resolution for the input media. | |
| fileData | GoogleCloudAiplatformV1FileData | 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. | |
| thoughtSignature | string | Optional. An opaque signature for the thought so it can be reused in subsequent requests. | format: byte |
| functionCall | GoogleCloudAiplatformV1FunctionCall | 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. | |
| inlineData | GoogleCloudAiplatformV1Blob | A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. | |
| codeExecutionResult | GoogleCloudAiplatformV1CodeExecutionResult | Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. | |
| speechMetadata | GoogleCloudAiplatformV1SpeechMetadata | Structured Metadata Sub-Message for Part | |
| text | string | Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. | |
| thought | boolean | Optional. Indicates whether the `part` represents the model's thought process or reasoning. | |
| videoMetadata | GoogleCloudAiplatformV1VideoMetadata | Provides metadata for a video, including the start and end offsets for clipping and the frame rate. | |
| audioTranscription | GoogleCloudAiplatformV1AudioTranscription | The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate `Part` with its own `AudioTranscription` carrying the `speaker_label`. |
GoogleCloudAiplatformV1PartialArgobject
Partial argument value of the function call.
| jsonPath | string | Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". | |
| numberValue | number | Optional. Represents a double value. | format: double |
| nullValue | enum | Optional. Represents a null value. | NULL_VALUE |
| willContinue | boolean | Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. | |
| stringValue | string | Optional. Represents a string value. | |
| boolValue | boolean | Optional. Represents a boolean value. |
GoogleCloudAiplatformV1PartMediaResolutionobject
per part media resolution. Media resolution for the input media.
| level | enum | The tokenization quality used for given media. | MEDIA_RESOLUTION_UNSPECIFIED | MEDIA_RESOLUTION_LOW | MEDIA_RESOLUTION_MEDIUM | MEDIA_RESOLUTION_HIGH | MEDIA_RESOLUTION_ULTRA_HIGH |
GoogleCloudAiplatformV1PrebuiltVoiceConfigobject
Configuration for a prebuilt voice.
| voiceName | string | The name of the prebuilt voice to use. |
GoogleCloudAiplatformV1RagRetrievalConfigobject
Specifies the context retrieval config.
| filter | GoogleCloudAiplatformV1RagRetrievalConfigFilter | Config for filters. | |
| ranking | GoogleCloudAiplatformV1RagRetrievalConfigRanking | Config for ranking and reranking. | |
| topK | integer | Optional. The number of contexts to retrieve. | format: int32 |
GoogleCloudAiplatformV1RagRetrievalConfigFilterobject
Config for filters.
| metadataFilter | string | Optional. String for metadata filtering. | |
| vectorSimilarityThreshold | number | Optional. Only returns contexts with vector similarity larger than the threshold. | format: double |
| vectorDistanceThreshold | number | Optional. Only returns contexts with vector distance smaller than the threshold. | format: double |
GoogleCloudAiplatformV1RagRetrievalConfigRankingobject
Config for ranking and reranking.
| rankService | GoogleCloudAiplatformV1RagRetrievalConfigRankingRankService | Config for Rank Service. | |
| llmRanker | GoogleCloudAiplatformV1RagRetrievalConfigRankingLlmRanker | Config for LlmRanker. |
GoogleCloudAiplatformV1RagRetrievalConfigRankingLlmRankerobject
Config for LlmRanker.
| modelName | string | Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). |
GoogleCloudAiplatformV1RagRetrievalConfigRankingRankServiceobject
Config for Rank Service.
| modelName | string | Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` |
GoogleCloudAiplatformV1ReplicatedVoiceConfigobject
The configuration for the replicated voice to use.
| voiceSampleAudio | string | Optional. The sample of the custom voice. | format: byte |
| mimeType | string | Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. |
GoogleCloudAiplatformV1ResponseFormatobject
Configuration for the model to configure output formatting and delivery.
| video | GoogleCloudAiplatformV1VideoResponseFormat | Configuration for video-specific output formatting. | |
| image | GoogleCloudAiplatformV1ImageResponseFormat | Configuration for image-specific output formatting. | |
| text | GoogleCloudAiplatformV1TextResponseFormat | Configuration for text-specific output formatting. | |
| audio | GoogleCloudAiplatformV1AudioResponseFormat | Configuration for audio-specific output formatting. |
GoogleCloudAiplatformV1Retrievalobject
Defines a retrieval tool that model can call to access external knowledge.
| vertexAiSearch | GoogleCloudAiplatformV1VertexAISearch | Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder | |
| vertexRagStore | GoogleCloudAiplatformV1VertexRagStore | Retrieve from Vertex RAG Store for grounding. | |
| disableAttribution | boolean | Optional. Deprecated. This option is no longer supported. | |
| externalApi | GoogleCloudAiplatformV1ExternalApi | 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. |
GoogleCloudAiplatformV1RetrievalConfigobject
Retrieval config.
| latLng | GoogleTypeLatLng | 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… | |
| languageCode | string | The language code of the user. |
GoogleCloudAiplatformV1SafetySettingobject
A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.
| threshold | enum | Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. | HARM_BLOCK_THRESHOLD_UNSPECIFIE… | BLOCK_LOW_AND_ABOVE | BLOCK_MEDIUM_AND_ABOVE | BLOCK_ONLY_HIGH | BLOCK_NONE | OFF |
| method | enum | Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. | HARM_BLOCK_METHOD_UNSPECIFIED | SEVERITY | PROBABILITY |
| category | enum | Required. The harm category to be blocked. | HARM_CATEGORY_UNSPECIFIED | HARM_CATEGORY_HATE_SPEECH | HARM_CATEGORY_DANGEROUS_CONTENT… | HARM_CATEGORY_HARASSMENT | HARM_CATEGORY_SEXUALLY_EXPLICIT… | HARM_CATEGORY_CIVIC_INTEGRITY · +5 more |
GoogleCloudAiplatformV1Schemaobject
Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object).
| minimum | number | Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. | format: double |
| minLength | string | Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. | format: int64 |
| ref | string | Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: … | |
| properties | object | Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. | |
| nullable | boolean | Optional. Indicates if the value of this field can be null. | |
| maximum | number | Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. | format: double |
| type | enum | Optional. Data type of the schema field. | TYPE_UNSPECIFIED | STRING | NUMBER | INTEGER | BOOLEAN | ARRAY · +2 more |
| maxProperties | string | Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. | format: int64 |
| example | any | Optional. Example of an instance of this schema. | |
| description | string | Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. | |
| enum | string[] | Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRI… | |
| additionalProperties | any | Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. | |
| required | string[] | Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. | |
| minProperties | string | Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. | format: int64 |
| defs | object | Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. | |
| title | string | Optional. Title for the schema. | |
| anyOf | GoogleCloudAiplatformV1Schema[] | Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. | |
| propertyOrdering | string[] | Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. | |
| maxItems | string | Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. | format: int64 |
| minItems | string | Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. | format: int64 |
| format | string | Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine… | |
| maxLength | string | Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. | format: int64 |
| default | any | Optional. Default value to use if the field is not specified. | |
| pattern | string | Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. | |
| items | GoogleCloudAiplatformV1Schema | Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). |
GoogleCloudAiplatformV1SpeakerVoiceConfigobject
Configuration for a single speaker in a multi-speaker setup.
| speaker | string | Required. The name of the speaker. This should be the same as the speaker name used in the prompt. | |
| voiceConfig | GoogleCloudAiplatformV1VoiceConfig | Configuration for a voice. |
GoogleCloudAiplatformV1SpeechConfigobject
Configuration for speech generation.
| voiceConfig | GoogleCloudAiplatformV1VoiceConfig | Configuration for a voice. | |
| multiSpeakerVoiceConfig | GoogleCloudAiplatformV1MultiSpeakerVoiceConfig | Configuration for a multi-speaker text-to-speech request. | |
| languageCode | string | Optional. The language code (ISO 639-1) for the speech synthesis. |
GoogleCloudAiplatformV1SpeechMetadataobject
Structured Metadata Sub-Message for Part
| style | string | Optional. Natural language description of the vocal style (e.g., "cheerful"). | |
| speaker | string | Optional. Identifies which speaker is speaking this turn. |
GoogleCloudAiplatformV1TextResponseFormatobject
Configuration for text-specific output formatting.
| mimeType | enum | Optional. The IANA standard MIME type of the response. | MIME_TYPE_UNSPECIFIED | APPLICATION_JSON | TEXT_PLAIN |
| schema | any | Optional. The JSON schema that the output should conform to. Only applicable when mime_type is APPLICATION_JSON. |
GoogleCloudAiplatformV1Toolobject
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 e…
| googleSearchRetrieval | GoogleCloudAiplatformV1GoogleSearchRetrieval | Tool to retrieve public web data for grounding, powered by Google. | |
| exaAiSearch | GoogleCloudAiplatformV1ToolExaAiSearch | ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. | |
| functionDeclarations | GoogleCloudAiplatformV1FunctionDeclaration[] | Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse… | |
| parallelAiSearch | GoogleCloudAiplatformV1ToolParallelAiSearch | ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. | |
| enterpriseWebSearch | GoogleCloudAiplatformV1EnterpriseWebSearch | Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. | |
| retrieval | GoogleCloudAiplatformV1Retrieval | Defines a retrieval tool that model can call to access external knowledge. | |
| codeExecution | GoogleCloudAiplatformV1ToolCodeExecution | 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. | |
| googleMaps | GoogleCloudAiplatformV1GoogleMaps | Tool to retrieve public maps data for grounding, powered by Google. | |
| urlContext | GoogleCloudAiplatformV1UrlContext | Tool to support URL context. | |
| googleSearch | GoogleCloudAiplatformV1ToolGoogleSearch | GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. | |
| computerUse | GoogleCloudAiplatformV1ToolComputerUse | A tool that enables the model to interact directly with a computer environment. |
GoogleCloudAiplatformV1ToolCodeExecutionobject
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.
GoogleCloudAiplatformV1ToolComputerUseobject
A tool that enables the model to interact directly with a computer environment.
| excludedPredefinedFunctions | string[] | Optional. A list of predefined functions to explicitly exclude from the model call. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included. Excluding functions allows for a more res… | |
| environment | enum | Required. The target environment where the computer use tool operates. | ENVIRONMENT_UNSPECIFIED | ENVIRONMENT_BROWSER | ENVIRONMENT_MOBILE | ENVIRONMENT_DESKTOP |
| enablePromptInjectionDetection | boolean | Optional. Whether to enable the prompt injection detection check on the computer use request. | |
| disabledSafetyPolicies | enum[] | Optional. A list of safety policies to disable for the computer use tool. |
GoogleCloudAiplatformV1ToolConfigobject
Tool config. This config is shared for all tools provided in the request.
| functionCallingConfig | GoogleCloudAiplatformV1FunctionCallingConfig | Function calling config. | |
| retrievalConfig | GoogleCloudAiplatformV1RetrievalConfig | Retrieval config. |
GoogleCloudAiplatformV1ToolExaAiSearchobject
ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding.
| apiKey | string | Required. The API key for ExaAiSearch. | |
| customConfigs | object | Optional. This field can be used to pass any parameter from the Exa.ai Search API. |
GoogleCloudAiplatformV1ToolGoogleSearchobject
GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
| excludeDomains | string[] | Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. | |
| searchTypes | GoogleCloudAiplatformV1ToolGoogleSearchSearchTypes | Different types of search that can be enabled on the GoogleSearch tool. | |
| blockingConfidence | enum | Optional. Sites with confidence level chosen & above this value will be blocked from the search results. | PHISH_BLOCK_THRESHOLD_UNSPECIFI… | BLOCK_LOW_AND_ABOVE | BLOCK_MEDIUM_AND_ABOVE | BLOCK_HIGH_AND_ABOVE | BLOCK_HIGHER_AND_ABOVE | BLOCK_VERY_HIGH_AND_ABOVE · +1 more |
GoogleCloudAiplatformV1ToolGoogleSearchImageSearchobject
Image search for grounding and related configurations.
GoogleCloudAiplatformV1ToolGoogleSearchSearchTypesobject
Different types of search that can be enabled on the GoogleSearch tool.
| webSearch | GoogleCloudAiplatformV1ToolGoogleSearchWebSearch | Standard web search for grounding and related configurations. Only text results are returned. | |
| imageSearch | GoogleCloudAiplatformV1ToolGoogleSearchImageSearch | Image search for grounding and related configurations. |
GoogleCloudAiplatformV1ToolGoogleSearchWebSearchobject
Standard web search for grounding and related configurations. Only text results are returned.
GoogleCloudAiplatformV1ToolParallelAiSearchobject
ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding.
| enableDataRetention | boolean | Optional. Deprecated: Use `enable_zero_data_retention` instead. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used.… | |
| customConfigs | object | Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/sea… | |
| enableZeroDataRetention | boolean | Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for … | |
| apiKey | string | Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart f… |
GoogleCloudAiplatformV1TranslationConfigobject
Config for translation features.
| targetLanguageCode | string | Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). | |
| echoTargetLanguage | boolean | Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. |
GoogleCloudAiplatformV1UrlContextobject
Tool to support URL context.
GoogleCloudAiplatformV1VertexAISearchobject
Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder
| filter | string | Optional. Filter strings to be passed to the search API. | |
| maxResults | integer | Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. | format: int32 |
| datastore | string | Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` | |
| dataStoreSpecs | GoogleCloudAiplatformV1VertexAISearchDataStoreSpec[] | Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. | |
| engine | string | Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` |
GoogleCloudAiplatformV1VertexAISearchDataStoreSpecobject
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
| dataStore | string | Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` | |
| filter | string | Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) |
GoogleCloudAiplatformV1VertexRagStoreobject
Retrieve from Vertex RAG Store for grounding.
| ragRetrievalConfig | GoogleCloudAiplatformV1RagRetrievalConfig | Specifies the context retrieval config. | |
| vectorDistanceThreshold | number | Optional. Only return results with vector distance smaller than the threshold. | format: double |
| similarityTopK | integer | Optional. Number of top k results to return from the selected corpora. | format: int32 |
| ragResources | GoogleCloudAiplatformV1VertexRagStoreRagResource[] | Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. |
GoogleCloudAiplatformV1VertexRagStoreRagResourceobject
The definition of the Rag resource.
| ragFileIds | string[] | Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. | |
| ragCorpus | string | Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` |
GoogleCloudAiplatformV1VideoMetadataobject
Provides metadata for a video, including the start and end offsets for clipping and the frame rate.
| fps | number | Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. | format: double |
| startOffset | string | Optional. The start offset of the video. | format: google-duration |
| endOffset | string | Optional. The end offset of the video. | format: google-duration |
GoogleCloudAiplatformV1VideoResponseFormatobject
Configuration for video-specific output formatting.
| delivery | enum | Optional. Delivery mode for the generated content. | DELIVERY_UNSPECIFIED | INLINE | URI |
| resolution | string | Optional. The video output resolution. Supported values: "360p", "720p", "1080p", "4k". | |
| aspectRatio | enum | The aspect ratio for the video output. | ASPECT_RATIO_UNSPECIFIED | ASPECT_RATIO_SIXTEEN_BY_NINE | ASPECT_RATIO_NINE_BY_SIXTEEN |
| gcsUri | string | Optional. The Google Cloud Storage URI to store the video output. Required for Vertex if delivery is URI. | |
| duration | string | Optional. The duration for the video output. | format: google-duration |
GoogleCloudAiplatformV1VoiceConfigobject
Configuration for a voice.
| replicatedVoiceConfig | GoogleCloudAiplatformV1ReplicatedVoiceConfig | The configuration for the replicated voice to use. | |
| prebuiltVoiceConfig | GoogleCloudAiplatformV1PrebuiltVoiceConfig | Configuration for a prebuilt voice. | |
| voice | string | Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). |
GoogleTypeLatLngobject
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…
| longitude | number | The longitude in degrees. It must be in the range [-180.0, +180.0]. | format: double |
| latitude | number | The latitude in degrees. It must be in the range [-90.0, +90.0]. | format: double |
Validate a payload
before you spend tokensshell
$ curl -X POST https://modelschemas.com/v1/validate \
-d '{"provider":"google-vertex","endpointId":"v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent","payload":{…}}'
→ {"valid": false, "errors": [{"path": "#", "keyword": "required", …}]}