--- title: "POST /v1/publishers/{publishersId}/models/{modelsId}:countTokens" method: POST path: "/v1/publishers/{publishersId}/models/{modelsId}:countTokens" tags: ["publishers"] --- # POST /v1/publishers/{publishersId}/models/{modelsId}:countTokens `POST /v1/publishers/{publishersId}/models/{modelsId}:countTokens` ## Request - Base URL: `https://aiplatform.googleapis.com` - URL: `https://aiplatform.googleapis.com/v1/publishers/{publishersId}/models/{modelsId}:countTokens` - Auth: OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/cloud-platform` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloud-platform` Perform a token counting. ## Path parameters - `publishersId` string, required - `modelsId` string, required ## Request body - GoogleCloudAiplatformV1CountTokensRequest: Request message for PredictionService.CountTokens. - `contents` GoogleCloudAiplatformV1Content[]: Optional. Input content. - `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. - `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`. - `speakerLabel` string: Optional. A label identifying the speaker of this audio segment (e.g. `spk_1`, `spk_2`). Present when `diarization` is set. - `text` string: Required. The transcription text of this audio segment. - `words` GoogleCloudAiplatformV1AudioTranscriptionWordInfo[]: Optional. Detailed word-level transcriptions and timing details. Present when `word_timestamp` is set. - `endOffset` string, google-duration: Optional. End offset in time of the word relative to the start of the audio. - `startOffset` string, google-duration: Optional. Start offset in time of the word relative to the start of the audio. - `word` string: Required. Transcript of the word. - `codeExecutionResult` GoogleCloudAiplatformV1CodeExecutionResult: Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. - `id` string: Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. - `outcome` 'OUTCOME_UNSPECIFIED' | 'OUTCOME_OK' | 'OUTCOME_FAILED' | 'OUTCOME_DEADLINE_EXCEEDED': Required. Outcome of the code execution. - `output` string: Optional. Contains stdout when code execution is successful, stderr or other description otherwise. - `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. - `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`. - `language` 'LANGUAGE_UNSPECIFIED' | 'PYTHON': Required. Programming language of the `code`. - `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. - `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`, and `url_context`) are enabled. - `fileUri` string: Required. The URI of the file in Google Cloud Storage. - `mimeType` string: Required. The IANA standard MIME type of the source data. - `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. - `args` object: Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. - `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`. - `name` string: Optional. The name of the function to call. Matches FunctionDeclaration.name. - `partialArgs` GoogleCloudAiplatformV1PartialArg[]: Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. - `boolValue` boolean: Optional. Represents a boolean value. - `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". - `nullValue` 'NULL_VALUE': Optional. Represents a null value. - `numberValue` number, double: Optional. Represents a double value. - `stringValue` string: Optional. Represents a string 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. - `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. - `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 based on model prediction. - `id` string: Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. - `name` string: Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. - `parts` GoogleCloudAiplatformV1FunctionResponsePart[]: Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. - `fileData` GoogleCloudAiplatformV1FunctionResponseFileData: URI based data for function response. - `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 (code_execution, google_search, and url_context) are enabled. - `fileUri` string: Required. URI. - `mimeType` string: Required. The IANA standard MIME type of the source data. - `inlineData` GoogleCloudAiplatformV1FunctionResponseBlob: Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. - `data` string, byte: Required. Raw bytes. - `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_execution, google_search, and url_context) are enabled. - `mimeType` string: Required. The IANA standard MIME type of the source data. - `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` 'SCHEDULING_UNSPECIFIED' | 'SILENT' | 'WHEN_IDLE' | 'INTERRUPT': 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. - `inlineData` GoogleCloudAiplatformV1Blob: A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. - `data` string, byte: Required. The raw bytes of the data. - `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`, and `url_context`) are enabled. - `mimeType` string: Required. The IANA standard MIME type of the source data. - `mediaResolution` GoogleCloudAiplatformV1PartMediaResolution: per part media resolution. Media resolution for the input media. - `level` 'MEDIA_RESOLUTION_UNSPECIFIED' | 'MEDIA_RESOLUTION_LOW' | 'MEDIA_RESOLUTION_MEDIUM' | 'MEDIA_RESOLUTION_HIGH' | 'MEDIA_RESOLUTION_ULTRA_HIGH': The tokenization quality used for given media. - `speechMetadata` GoogleCloudAiplatformV1SpeechMetadata: Structured Metadata Sub-Message for Part - `speaker` string: Optional. Identifies which speaker is speaking this turn. - `style` string: Optional. Natural language description of the vocal style (e.g., "cheerful"). - `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. - `thoughtSignature` string, byte: Optional. An opaque signature for the thought so it can be reused in subsequent requests. - `videoMetadata` GoogleCloudAiplatformV1VideoMetadata: Provides metadata for a video, including the start and end offsets for clipping and the frame rate. - `endOffset` string, google-duration: Optional. The end offset of the video. - `fps` number, double: 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]. - `startOffset` string, google-duration: Optional. The start offset of the video. - `role` string: Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. - `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. - `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. - `audioTranscriptionConfig` GoogleCloudAiplatformV1AudioTranscriptionConfig: Configuration for speech recognition (transcription). - `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. - `diarization` boolean: Optional. Configures speaker diarization. - `languageAuto` GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageAuto: Deprecated: Use top-level `language_codes` instead. Indicates the language of the audio should be automatically detected. - `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. - `languageHints` GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageHints: 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. - `mode` 'MODE_UNSPECIFIED' | 'VERBATIM' | 'SMART': 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 grammatical cleanup, automatic formatting (paragraphs, bullet points, numbered lists), and minor user edits (inline self-corrections). Timestamps and diarization are incompatible with mode `SMART`. - `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. - `wordTimestamp` boolean: Optional. Configures word-level timestamp generation. - `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. - `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. - `frequencyPenalty` number, float: 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]. - `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. - `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. - `compressionQuality` integer: Optional. The compression quality of the output image. - `mimeType` string: Optional. The image format that the output should be saved as. - `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`. - `personGeneration` 'PERSON_GENERATION_UNSPECIFIED' | 'ALLOW_ALL' | 'ALLOW_ADULT' | 'ALLOW_NONE': Optional. Controls whether the model can generate people. - `prominentPeople` 'PROMINENT_PEOPLE_UNSPECIFIED' | 'ALLOW_PROMINENT_PEOPLE' | 'BLOCK_PROMINENT_PEOPLE': 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 unspecified, the default behavior is to allow prominent people. - `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 response. - `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. - `mediaResolution` 'MEDIA_RESOLUTION_UNSPECIFIED' | 'MEDIA_RESOLUTION_LOW' | 'MEDIA_RESOLUTION_MEDIUM' | 'MEDIA_RESOLUTION_HIGH': 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, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. - `presencePenalty` number, float: 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]. - `responseFormat` GoogleCloudAiplatformV1ResponseFormat[]: Optional. New response format field for the model to configure output formatting and delivery. - `audio` GoogleCloudAiplatformV1AudioResponseFormat: Configuration for audio-specific output formatting. - `bitRate` integer: Optional. Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - `delivery` 'DELIVERY_UNSPECIFIED' | 'INLINE' | 'URI': Optional. Delivery mode for the generated content. - `mimeType` 'MIME_TYPE_UNSPECIFIED' | 'AUDIO_MP3' | 'AUDIO_OGG_OPUS' | 'AUDIO_L16' | 'AUDIO_WAV' | 'AUDIO_ALAW' | 'AUDIO_MULAW': Optional. The MIME type of the audio output. - `sampleRate` integer: Optional. Sample rate for the generated audio in Hertz. - `image` GoogleCloudAiplatformV1ImageResponseFormat: Configuration for image-specific output formatting. - `aspectRatio` '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' | 'ASPECT_RATIO_FOUR_BY_FIVE' | 'ASPECT_RATIO_FIVE_BY_FOUR' | 'ASPECT_RATIO_NINE_BY_SIXTEEN' | 'ASPECT_RATIO_SIXTEEN_BY_NINE' | 'ASPECT_RATIO_TWENTY_ONE_BY_NINE' | 'ASPECT_RATIO_ONE_BY_EIGHT' | 'ASPECT_RATIO_EIGHT_BY_ONE' | 'ASPECT_RATIO_ONE_BY_FOUR' | 'ASPECT_RATIO_FOUR_BY_ONE': Optional. The aspect ratio for the image output. - `delivery` 'DELIVERY_UNSPECIFIED' | 'INLINE' | 'URI': Optional. Delivery mode for the generated content. - `imageSize` 'IMAGE_SIZE_UNSPECIFIED' | 'IMAGE_SIZE_FIVE_TWELVE' | 'IMAGE_SIZE_ONE_K' | 'IMAGE_SIZE_TWO_K' | 'IMAGE_SIZE_FOUR_K': Optional. The size of the image output. - `mimeType` 'MIME_TYPE_UNSPECIFIED' | 'IMAGE_JPEG': Optional. The MIME type of the image output. - `text` GoogleCloudAiplatformV1TextResponseFormat: Configuration for text-specific output formatting. - `mimeType` 'MIME_TYPE_UNSPECIFIED' | 'APPLICATION_JSON' | 'TEXT_PLAIN': Optional. The IANA standard MIME type of the response. - `schema` unknown - `video` GoogleCloudAiplatformV1VideoResponseFormat: Configuration for video-specific output formatting. - `aspectRatio` 'ASPECT_RATIO_UNSPECIFIED' | 'ASPECT_RATIO_SIXTEEN_BY_NINE' | 'ASPECT_RATIO_NINE_BY_SIXTEEN': The aspect ratio for the video output. - `delivery` 'DELIVERY_UNSPECIFIED' | 'INLINE' | 'URI': Optional. Delivery mode for the generated content. - `duration` string, google-duration: Optional. The duration for the video output. - `gcsUri` string: Optional. The Google Cloud Storage URI to store the video output. Required for Vertex if delivery is URI. - `resolution` string: Optional. The video output resolution. Supported values: "360p", "720p", "1080p", "4k". - `responseJsonSchema` unknown - `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 useful for analyzing the model's confidence in its own output and for debugging. - `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 type, otherwise the behavior is undefined. Deprecated: Use `response_format` instead. - `responseModalities` string[]: 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. - `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). - `additionalProperties` unknown - `anyOf` GoogleCloudAiplatformV1Schema[]: Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - `default` unknown - `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. - `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:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - `example` unknown - `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 the data type. - `items` GoogleCloudAiplatformV1Schema (recursive) - `maxItems` string, int64: Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - `maxLength` string, int64: Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - `maxProperties` string, int64: Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - `maximum` number, double: Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - `minItems` string, int64: Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - `minLength` string, int64: Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - `minProperties` string, int64: Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - `minimum` number, double: Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - `nullable` boolean: Optional. Indicates if the value of this field can be null. - `pattern` string: Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - `properties` object: Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - `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. - `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: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - `required` string[]: Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - `title` string: Optional. Title for the schema. - `type` 'TYPE_UNSPECIFIED' | 'STRING' | 'NUMBER' | 'INTEGER' | 'BOOLEAN' | 'ARRAY' | 'OBJECT' | 'NULL': Optional. Data type of the schema field. - `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. - `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. - `modelRoutingPreference` 'UNKNOWN' | 'PRIORITIZE_QUALITY' | 'BALANCED' | 'PRIORITIZE_COST': The 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. - `modelName` string: The name of the model to use. Only public LLM models are accepted. - `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 a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. - `speechConfig` GoogleCloudAiplatformV1SpeechConfig: Configuration for speech generation. - `languageCode` string: Optional. The language code (ISO 639-1) for the speech synthesis. - `multiSpeakerVoiceConfig` GoogleCloudAiplatformV1MultiSpeakerVoiceConfig: 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. - `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. - `prebuiltVoiceConfig` GoogleCloudAiplatformV1PrebuiltVoiceConfig: Configuration for a prebuilt voice. - … - `replicatedVoiceConfig` GoogleCloudAiplatformV1ReplicatedVoiceConfig: The configuration for the replicated voice to use. - … - `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`). - `voiceConfig` GoogleCloudAiplatformV1VoiceConfig: Configuration for a voice. - `prebuiltVoiceConfig` GoogleCloudAiplatformV1PrebuiltVoiceConfig: Configuration for a prebuilt voice. - `voiceName` string: The name of the prebuilt voice to use. - `replicatedVoiceConfig` GoogleCloudAiplatformV1ReplicatedVoiceConfig: The configuration for the replicated voice to use. - `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. - `voiceSampleAudio` string, byte: Optional. The sample of the custom 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`). - `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 ["\n", "###"] to stop generation at a new line or a specific marker. - `temperature` number, float: 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]. - `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-quality response. - `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, thoughts are returned only when available. - `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. - `thinkingLevel` 'THINKING_LEVEL_UNSPECIFIED' | 'LOW' | 'MEDIUM' | 'HIGH' | 'MINIMAL': Optional. The number of thoughts tokens that the model should generate. - `topK` number, float: 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 next word from the 40 most likely words. - `topP` number, float: 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 model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. - `translationConfig` GoogleCloudAiplatformV1TranslationConfig: Config for translation features. - `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. - `targetLanguageCode` string: Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). - `instances` unknown[]: Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. - unknown - `model` string: Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` - `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. - `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. - `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`. - `speakerLabel` string: Optional. A label identifying the speaker of this audio segment (e.g. `spk_1`, `spk_2`). Present when `diarization` is set. - `text` string: Required. The transcription text of this audio segment. - `words` GoogleCloudAiplatformV1AudioTranscriptionWordInfo[]: Optional. Detailed word-level transcriptions and timing details. Present when `word_timestamp` is set. - `endOffset` string, google-duration: Optional. End offset in time of the word relative to the start of the audio. - `startOffset` string, google-duration: Optional. Start offset in time of the word relative to the start of the audio. - `word` string: Required. Transcript of the word. - `codeExecutionResult` GoogleCloudAiplatformV1CodeExecutionResult: Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. - `id` string: Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. - `outcome` 'OUTCOME_UNSPECIFIED' | 'OUTCOME_OK' | 'OUTCOME_FAILED' | 'OUTCOME_DEADLINE_EXCEEDED': Required. Outcome of the code execution. - `output` string: Optional. Contains stdout when code execution is successful, stderr or other description otherwise. - `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. - `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`. - `language` 'LANGUAGE_UNSPECIFIED' | 'PYTHON': Required. Programming language of the `code`. - `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. - `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`, and `url_context`) are enabled. - `fileUri` string: Required. The URI of the file in Google Cloud Storage. - `mimeType` string: Required. The IANA standard MIME type of the source data. - `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. - `args` object: Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. - `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`. - `name` string: Optional. The name of the function to call. Matches FunctionDeclaration.name. - `partialArgs` GoogleCloudAiplatformV1PartialArg[]: Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. - `boolValue` boolean: Optional. Represents a boolean value. - `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". - `nullValue` 'NULL_VALUE': Optional. Represents a null value. - `numberValue` number, double: Optional. Represents a double value. - `stringValue` string: Optional. Represents a string 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. - `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. - `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 based on model prediction. - `id` string: Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. - `name` string: Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. - `parts` GoogleCloudAiplatformV1FunctionResponsePart[]: Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. - `fileData` GoogleCloudAiplatformV1FunctionResponseFileData: URI based data for function response. - `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 (code_execution, google_search, and url_context) are enabled. - `fileUri` string: Required. URI. - `mimeType` string: Required. The IANA standard MIME type of the source data. - `inlineData` GoogleCloudAiplatformV1FunctionResponseBlob: Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. - `data` string, byte: Required. Raw bytes. - `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_execution, google_search, and url_context) are enabled. - `mimeType` string: Required. The IANA standard MIME type of the source data. - `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` 'SCHEDULING_UNSPECIFIED' | 'SILENT' | 'WHEN_IDLE' | 'INTERRUPT': 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. - `inlineData` GoogleCloudAiplatformV1Blob: A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. - `data` string, byte: Required. The raw bytes of the data. - `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`, and `url_context`) are enabled. - `mimeType` string: Required. The IANA standard MIME type of the source data. - `mediaResolution` GoogleCloudAiplatformV1PartMediaResolution: per part media resolution. Media resolution for the input media. - `level` 'MEDIA_RESOLUTION_UNSPECIFIED' | 'MEDIA_RESOLUTION_LOW' | 'MEDIA_RESOLUTION_MEDIUM' | 'MEDIA_RESOLUTION_HIGH' | 'MEDIA_RESOLUTION_ULTRA_HIGH': The tokenization quality used for given media. - `speechMetadata` GoogleCloudAiplatformV1SpeechMetadata: Structured Metadata Sub-Message for Part - `speaker` string: Optional. Identifies which speaker is speaking this turn. - `style` string: Optional. Natural language description of the vocal style (e.g., "cheerful"). - `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. - `thoughtSignature` string, byte: Optional. An opaque signature for the thought so it can be reused in subsequent requests. - `videoMetadata` GoogleCloudAiplatformV1VideoMetadata: Provides metadata for a video, including the start and end offsets for clipping and the frame rate. - `endOffset` string, google-duration: Optional. The end offset of the video. - `fps` number, double: 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]. - `startOffset` string, google-duration: Optional. The start offset of the video. - `role` string: Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. - `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. - `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. - `computerUse` GoogleCloudAiplatformV1ToolComputerUse: A tool that enables the model to interact directly with a computer environment. - `disabledSafetyPolicies` string[]: Optional. A list of safety policies to disable for the computer use tool. - `enablePromptInjectionDetection` boolean: Optional. Whether to enable the prompt injection detection check on the computer use request. - `environment` 'ENVIRONMENT_UNSPECIFIED' | 'ENVIRONMENT_BROWSER' | 'ENVIRONMENT_MOBILE' | 'ENVIRONMENT_DESKTOP': Required. The target environment where the computer use tool operates. - `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 restricted action space or custom definitions for predefined functions. - `enterpriseWebSearch` GoogleCloudAiplatformV1EnterpriseWebSearch: Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. - `blockingConfidence` 'PHISH_BLOCK_THRESHOLD_UNSPECIFIED' | 'BLOCK_LOW_AND_ABOVE' | 'BLOCK_MEDIUM_AND_ABOVE' | 'BLOCK_HIGH_AND_ABOVE' | 'BLOCK_HIGHER_AND_ABOVE' | 'BLOCK_VERY_HIGH_AND_ABOVE' | 'BLOCK_ONLY_EXTREMELY_HIGH': Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - `excludeDomains` string[]: Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. - `exaAiSearch` GoogleCloudAiplatformV1ToolExaAiSearch: 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. - `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 for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. - `behavior` 'UNSPECIFIED' | 'BLOCKING' | 'NON_BLOCKING': 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. - `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). - `additionalProperties` unknown - `anyOf` GoogleCloudAiplatformV1Schema[]: Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - `default` unknown - `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. - `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:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - `example` unknown - `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 the data type. - `items` GoogleCloudAiplatformV1Schema (recursive) - `maxItems` string, int64: Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - `maxLength` string, int64: Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - `maxProperties` string, int64: Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - `maximum` number, double: Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - `minItems` string, int64: Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - `minLength` string, int64: Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - `minProperties` string, int64: Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - `minimum` number, double: Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - `nullable` boolean: Optional. Indicates if the value of this field can be null. - `pattern` string: Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - `properties` object: Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - `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. - `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: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - `required` string[]: Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - `title` string: Optional. Title for the schema. - `type` 'TYPE_UNSPECIFIED' | 'STRING' | 'NUMBER' | 'INTEGER' | 'BOOLEAN' | 'ARRAY' | 'OBJECT' | 'NULL': Optional. Data type of the schema field. - `parametersJsonSchema` unknown - `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). - `additionalProperties` unknown - `anyOf` GoogleCloudAiplatformV1Schema[]: Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - `default` unknown - `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. - `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:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - `example` unknown - `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 the data type. - `items` GoogleCloudAiplatformV1Schema (recursive) - `maxItems` string, int64: Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - `maxLength` string, int64: Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - `maxProperties` string, int64: Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - `maximum` number, double: Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - `minItems` string, int64: Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - `minLength` string, int64: Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - `minProperties` string, int64: Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - `minimum` number, double: Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - `nullable` boolean: Optional. Indicates if the value of this field can be null. - `pattern` string: Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - `properties` object: Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - `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. - `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: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - `required` string[]: Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. - `title` string: Optional. Title for the schema. - `type` 'TYPE_UNSPECIFIED' | 'STRING' | 'NUMBER' | 'INTEGER' | 'BOOLEAN' | 'ARRAY' | 'OBJECT' | 'NULL': Optional. Data type of the schema field. - `responseJsonSchema` unknown - `googleMaps` GoogleCloudAiplatformV1GoogleMaps: 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. - `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). - `googleSearch` GoogleCloudAiplatformV1ToolGoogleSearch: GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. - `blockingConfidence` 'PHISH_BLOCK_THRESHOLD_UNSPECIFIED' | 'BLOCK_LOW_AND_ABOVE' | 'BLOCK_MEDIUM_AND_ABOVE' | 'BLOCK_HIGH_AND_ABOVE' | 'BLOCK_HIGHER_AND_ABOVE' | 'BLOCK_VERY_HIGH_AND_ABOVE' | 'BLOCK_ONLY_EXTREMELY_HIGH': Optional. Sites with confidence level chosen & above this value will be blocked from the search results. - `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. - `imageSearch` GoogleCloudAiplatformV1ToolGoogleSearchImageSearch: Image search for grounding and related configurations. - `webSearch` GoogleCloudAiplatformV1ToolGoogleSearchWebSearch: Standard web search for grounding and related configurations. Only text results are returned. - `googleSearchRetrieval` GoogleCloudAiplatformV1GoogleSearchRetrieval: Tool to retrieve public web data for grounding, powered by Google. - `dynamicRetrievalConfig` GoogleCloudAiplatformV1DynamicRetrievalConfig: Describes the options to customize dynamic retrieval. - `dynamicThreshold` number, float: Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. - `mode` 'MODE_UNSPECIFIED' | 'MODE_DYNAMIC': The mode of the predictor to be used in dynamic retrieval. - `parallelAiSearch` GoogleCloudAiplatformV1ToolParallelAiSearch: ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. - `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 for more details. - `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/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } - `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. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used. - `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 Grounding - ZDR subscription will be used. - `retrieval` GoogleCloudAiplatformV1Retrieval: Defines a retrieval tool that model can call to access external knowledge. - `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. - `apiAuth` GoogleCloudAiplatformV1ApiAuth: The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. - `apiKeyConfig` GoogleCloudAiplatformV1ApiAuthApiKeyConfig: The API secret. - `apiKeySecretVersion` string: Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} - `apiKeyString` string: The API key string. Either this or `api_key_secret_version` must be set. - `apiSpec` 'API_SPEC_UNSPECIFIED' | 'SIMPLE_SEARCH' | 'ELASTIC_SEARCH': The API spec that the external API implements. - `authConfig` GoogleCloudAiplatformV1AuthConfig: Auth configuration to run the extension. - `apiKeyConfig` GoogleCloudAiplatformV1AuthConfigApiKeyConfig: 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_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - `apiKeyString` string: Optional. The API key to be used in the request directly. - `httpElementLocation` 'HTTP_IN_UNSPECIFIED' | 'HTTP_IN_QUERY' | 'HTTP_IN_HEADER' | 'HTTP_IN_PATH' | 'HTTP_IN_BODY' | 'HTTP_IN_COOKIE': Optional. The location of the API key. - `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. - `authType` 'AUTH_TYPE_UNSPECIFIED' | 'NO_AUTH' | 'API_KEY_AUTH' | 'HTTP_BASIC_AUTH' | 'GOOGLE_SERVICE_ACCOUNT_AUTH' | 'OAUTH' | 'OIDC_AUTH': Type of auth scheme. - `googleServiceAccountConfig` GoogleCloudAiplatformV1AuthConfigGoogleServiceAccountConfig: 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/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. - `httpBasicAuthConfig` GoogleCloudAiplatformV1AuthConfigHttpBasicAuthConfig: 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 AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. - `oauthConfig` GoogleCloudAiplatformV1AuthConfigOauthConfig: Config for user oauth. - `accessToken` string: Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - `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-ai/docs/general/access-control#service-agents) on the provided service account. - `oidcConfig` GoogleCloudAiplatformV1AuthConfigOidcConfig: Config for user OIDC auth. - `idToken` string: OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. - `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). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). - `elasticSearchParams` GoogleCloudAiplatformV1ExternalApiElasticSearchParams: The search parameters to use for the ELASTIC_SEARCH spec. - `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. - `searchTemplate` string: The ElasticSearch search template to use. - `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 - `simpleSearchParams` GoogleCloudAiplatformV1ExternalApiSimpleSearchParams: The search parameters to use for SIMPLE_SEARCH spec. - `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 - `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. - `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) - `datastore` string: Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - `engine` string: Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` - `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. - `vertexRagStore` GoogleCloudAiplatformV1VertexRagStore: Retrieve from Vertex RAG Store for grounding. - `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. - `ragCorpus` string: Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` - `ragFileIds` string[]: Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - `ragRetrievalConfig` GoogleCloudAiplatformV1RagRetrievalConfig: Specifies the context retrieval config. - `filter` GoogleCloudAiplatformV1RagRetrievalConfigFilter: Config for filters. - `metadataFilter` string: Optional. String for metadata filtering. - `vectorDistanceThreshold` number, double: Optional. Only returns contexts with vector distance smaller than the threshold. - `vectorSimilarityThreshold` number, double: Optional. Only returns contexts with vector similarity larger than the threshold. - `ranking` GoogleCloudAiplatformV1RagRetrievalConfigRanking: Config for ranking and reranking. - `llmRanker` GoogleCloudAiplatformV1RagRetrievalConfigRankingLlmRanker: Config for LlmRanker. - … - `rankService` GoogleCloudAiplatformV1RagRetrievalConfigRankingRankService: Config for Rank Service. - … - `topK` integer: Optional. The number of contexts to retrieve. - `similarityTopK` integer: Optional. Number of top k results to return from the selected corpora. - `vectorDistanceThreshold` number, double: Optional. Only return results with vector distance smaller than the threshold. - `urlContext` GoogleCloudAiplatformV1UrlContext: Tool to support URL context. ## Response `200` Successful response - GoogleCloudAiplatformV1CountTokensResponse: Response message for PredictionService.CountTokens. - `promptTokensDetails` GoogleCloudAiplatformV1ModalityTokenCount[]: Output only. List of modalities that were processed in the request input. - `modality` 'MODALITY_UNSPECIFIED' | 'TEXT' | 'IMAGE' | 'VIDEO' | 'AUDIO' | 'DOCUMENT': The modality that this token count applies to. - `tokenCount` integer: The number of tokens counted for this modality. - `totalBillableCharacters` integer: The total number of billable characters counted across all instances from the request. - `totalTokens` integer: The total number of tokens counted across all instances from the request. --- [API](https://skmtc.dev/google/apis/aiplatform.md) - [All operations](https://skmtc.dev/google/apis/aiplatform/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/aiplatform/revisions/3aca3b348f0c?raw)