Console
    Start free

    MCP Tools Reference: aiplatform.googleapis.com

    Tool: count_tokens

    Calculates the number of tokens in a given input without generating a response, helping you manage rate limits and estimate the cost of a request before sending it.

    The following sample demonstrate how to use curl to invoke the count_tokens MCP tool.

    Curl Request 
      
curl  
--location  
 'https://aiplatform.googleapis.com/mcp/generate' 
  
 \ 
--header  
 'content-type: application/json' 
  
 \ 
--header  
 'accept: application/json, text/event-stream' 
  
 \ 
--data  
 '{ 
 "method": "tools/call", 
 "params": { 
 "name": "count_tokens", 
 "arguments": { 
 // provide these details according to the tool' 
s  
MCP  
specification  
 } 
  
 } 
,  
 "jsonrpc" 
:  
 "2.0" 
,  
 "id" 
:  
 1 
 } 
 '

    Input Schema

    Request message for PredictionService.CountTokens .

    CountTokensRequest

    JSON representation 
     { 
 "endpoint" 
 : 
 string 
 , 
 "model" 
 : 
 string 
 , 
 "instances" 
 : 
 [ 
 value 
 ] 
 , 
 "contents" 
 : 
 [ 
 { 
 object (  Content 
 
) 
 } 
 ] 
 , 
 "tools" 
 : 
 [ 
 { 
 object (  Tool 
 
) 
 } 
 ] 
 , 
 // Union field _system_instruction 
can be only one of the following: 
 "systemInstruction" 
 : 
 { 
 object (  Content 
 
) 
 } 
 // End of list of possible types for union field _system_instruction 
. 
 // Union field _generation_config 
can be only one of the following: 
 "generationConfig" 
 : 
 { 
 object (  GenerationConfig 
 
) 
 } 
 // End of list of possible types for union field _generation_config 
. 
 }
    Fields
    endpoint

    string

    Required. The name of the Endpoint requested to perform token counting. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

    model

    string

    Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*

    instances[]

    value ( Value format)

    Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.

    contents[]

    object ( Content )

    Optional. Input content.

    tools[]

    object ( Tool )

    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.

    Union field _system_instruction .

    _system_instruction can be only one of the following:

    systemInstruction

    object ( Content )

    Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph.

    Union field _generation_config .

    _generation_config can be only one of the following:

    generationConfig

    object ( GenerationConfig )

    Optional. Generation config that the model will use to generate the response.

    Value

    JSON representation 
     { 
 // Union field kind 
can be only one of the following: 
 "nullValue" 
 : 
 null 
 , 
 "numberValue" 
 : 
 number 
 , 
 "stringValue" 
 : 
 string 
 , 
 "boolValue" 
 : 
 boolean 
 , 
 "structValue" 
 : 
 { 
 object 
 } 
 , 
 "listValue" 
 : 
 array 
 // End of list of possible types for union field kind 
. 
 }
    Fields
    Union field kind . The kind of value. kind can be only one of the following:
    nullValue

    null

    Represents a JSON null .

    numberValue

    number

    Represents a JSON number. Must not be NaN , Infinity or -Infinity , since those are not supported in JSON. This also cannot represent large Int64 values, since JSON format generally does not support them in its number type.

    stringValue

    string

    Represents a JSON string.

    boolValue

    boolean

    Represents a JSON boolean ( true or false literal in JSON).

    structValue

    object ( Struct format)

    Represents a JSON object.

    listValue

    array ( ListValue format)

    Represents a JSON array.

    Struct

    JSON representation 
     { 
 "fields" 
 : 
 { 
 string 
 : 
 value 
 , 
 ... 
 } 
 }
    Fields
    fields

    map (key: string, value: value ( Value format))

    Unordered map of dynamically typed values.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

    FieldsEntry

    JSON representation 
     { 
 "key" 
 : 
 string 
 , 
 "value" 
 : 
 value 
 }
    Fields
    key

    string

    value

    value ( Value format)

    ListValue

    JSON representation 
     { 
 "values" 
 : 
 [ 
 value 
 ] 
 }
    Fields
    values[]

    value ( Value format)

    Repeated field of dynamically typed values.

    Content

    JSON representation 
     { 
 "role" 
 : 
 string 
 , 
 "parts" 
 : 
 [ 
 { 
 object (  Part 
 
) 
 } 
 ] 
 }
    Fields
    role

    string

    Optional. The producer of the content. Must be either 'user' or 'model'.

    If not set, the service will default to 'user'.
    parts[]

    object ( Part )

    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 .

    Part

    JSON representation 
     { 
 "thought" 
 : 
 boolean 
 , 
 "thoughtSignature" 
 : 
 string 
 , 
 "mediaResolution" 
 : 
 { 
 object (  MediaResolution 
 
) 
 } 
 , 
 // Union field data 
can be only one of the following: 
 "text" 
 : 
 string 
 , 
 "inlineData" 
 : 
 { 
 object (  Blob 
 
) 
 } 
 , 
 "fileData" 
 : 
 { 
 object (  FileData 
 
) 
 } 
 , 
 "functionCall" 
 : 
 { 
 object (  FunctionCall 
 
) 
 } 
 , 
 "functionResponse" 
 : 
 { 
 object (  FunctionResponse 
 
) 
 } 
 , 
 "executableCode" 
 : 
 { 
 object (  ExecutableCode 
 
) 
 } 
 , 
 "codeExecutionResult" 
 : 
 { 
 object (  CodeExecutionResult 
 
) 
 } 
 // End of list of possible types for union field data 
. 
 // Union field metadata 
can be only one of the following: 
 "videoMetadata" 
 : 
 { 
 object (  VideoMetadata 
 
) 
 } 
 // End of list of possible types for union field metadata 
. 
 }
    Fields
    thought

    boolean

    Optional. Indicates whether the part represents the model's thought process or reasoning.

    thoughtSignature

    string ( bytes format)

    Optional. An opaque signature for the thought so it can be reused in subsequent requests.

    A base64-encoded string.

    mediaResolution

    object ( MediaResolution )

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

    Union field data .

    data can be only one of the following:

    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.

    inlineData

    object ( Blob )

    Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.

    fileData

    object ( FileData )

    Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.

    functionCall

    object ( FunctionCall )

    Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.

    functionResponse

    object ( FunctionResponse )

    Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.

    executableCode

    object ( ExecutableCode )

    Optional. Code generated by the model that is intended to be executed.

    codeExecutionResult

    object ( CodeExecutionResult )

    Optional. The result of executing the ExecutableCode .

    Union field metadata .

    metadata can be only one of the following:

    videoMetadata

    object ( VideoMetadata )

    Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.

    Blob

    JSON representation 
     { 
 "mimeType" 
 : 
 string 
 , 
 "data" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 }
    Fields
    mimeType

    string

    Required. The IANA standard MIME type of the source data.
    data

    string ( bytes format)

    Required. The raw bytes of the data.

    A base64-encoded string.
    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.

    FileData

    JSON representation 
     { 
 "mimeType" 
 : 
 string 
 , 
 "fileUri" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 }
    Fields
    mimeType

    string

    Required. The IANA standard MIME type of the source data.
    fileUri

    string

    Required. The URI of the file 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.

    FunctionCall

    JSON representation 
     { 
 "id" 
 : 
 string 
 , 
 "name" 
 : 
 string 
 , 
 "args" 
 : 
 { 
 object 
 } 
 , 
 "partialArgs" 
 : 
 [ 
 { 
 object (  PartialArg 
 
) 
 } 
 ] 
 , 
 "willContinue" 
 : 
 boolean 
 }
    Fields
    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 .
    args

    object ( Struct format)

    Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details.
    partialArgs[]

    object ( PartialArg )

    Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.
    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.

    PartialArg

    JSON representation 
     { 
 "jsonPath" 
 : 
 string 
 , 
 "willContinue" 
 : 
 boolean 
 , 
 // Union field delta 
can be only one of the following: 
 "nullValue" 
 : 
 null 
 , 
 "numberValue" 
 : 
 number 
 , 
 "stringValue" 
 : 
 string 
 , 
 "boolValue" 
 : 
 boolean 
 // End of list of possible types for union field delta 
. 
 }
    Fields
    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".

    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.

    Union field delta . The delta of field value being streamed. delta can be only one of the following:
    nullValue

    null

    Optional. Represents a null value.

    numberValue

    number

    Optional. Represents a double value.

    stringValue

    string

    Optional. Represents a string value.

    boolValue

    boolean

    Optional. Represents a boolean value.

    FunctionResponse

    JSON representation 
     { 
 "id" 
 : 
 string 
 , 
 "name" 
 : 
 string 
 , 
 "response" 
 : 
 { 
 object 
 } 
 , 
 "parts" 
 : 
 [ 
 { 
 object (  FunctionResponsePart 
 
) 
 } 
 ] 
 }
    Fields
    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 .
    response

    object ( Struct format)

    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.
    parts[]

    object ( FunctionResponsePart )

    Optional. Ordered Parts that constitute a function response. Parts may have different IANA MIME types.

    FunctionResponsePart

    JSON representation 
     { 
 // Union field data 
can be only one of the following: 
 "inlineData" 
 : 
 { 
 object (  FunctionResponseBlob 
 
) 
 } 
 , 
 "fileData" 
 : 
 { 
 object (  FunctionResponseFileData 
 
) 
 } 
 // End of list of possible types for union field data 
. 
 }
    Fields
    Union field data . The data of the function response part. data can be only one of the following:
    inlineData

    object ( FunctionResponseBlob )

    Inline media bytes.

    fileData

    object ( FunctionResponseFileData )

    URI based data.

    FunctionResponseBlob

    JSON representation 
     { 
 "mimeType" 
 : 
 string 
 , 
 "data" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 }
    Fields
    mimeType

    string

    Required. The IANA standard MIME type of the source data.
    data

    string ( bytes format)

    Required. Raw bytes.

    A base64-encoded string.
    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.

    FunctionResponseFileData

    JSON representation 
     { 
 "mimeType" 
 : 
 string 
 , 
 "fileUri" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 }
    Fields
    mimeType

    string

    Required. The IANA standard MIME type of the source data.
    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 (code_execution, google_search, and url_context) are enabled.

    ExecutableCode

    JSON representation 
     { 
 "language" 
 : 
 enum ( Language 
) 
 , 
 "code" 
 : 
 string 
 }
    Fields
    language

    enum ( Language )

    Required. Programming language of the code .
    code

    string

    Required. The code to be executed.

    CodeExecutionResult

    JSON representation 
     { 
 "outcome" 
 : 
 enum ( Outcome 
) 
 , 
 "output" 
 : 
 string 
 }
    Fields
    outcome

    enum ( Outcome )

    Required. Outcome of the code execution.
    output

    string

    Optional. Contains stdout when code execution is successful, stderr or other description otherwise.

    VideoMetadata

    JSON representation 
     { 
 "startOffset" 
 : 
 string 
 , 
 "endOffset" 
 : 
 string 
 , 
 "fps" 
 : 
 number 
 }
    Fields
    startOffset

    string ( Duration format)

    Optional. The start offset of the video.

    A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .
    endOffset

    string ( Duration format)

    Optional. The end offset of the video.

    A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .
    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].

    Duration

    JSON representation 
     { 
 "seconds" 
 : 
 string 
 , 
 "nanos" 
 : 
 integer 
 }
    Fields
    seconds

    string ( int64 format)

    Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
    nanos

    integer

    Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 seconds field and a positive or negative nanos field. For durations of one second or more, a non-zero value for the nanos field must be of the same sign as the seconds field. Must be from -999,999,999 to +999,999,999 inclusive.

    MediaResolution

    JSON representation 
     { 
 // Union field value 
can be only one of the following: 
 "level" 
 : 
 enum ( Level 
) 
 // End of list of possible types for union field value 
. 
 }
    Fields

    Union field value .

    value can be only one of the following:

    level

    enum ( Level )

    The tokenization quality used for given media.

    Tool

    JSON representation 
     { 
 "functionDeclarations" 
 : 
 [ 
 { 
 object (  FunctionDeclaration 
 
) 
 } 
 ] 
 , 
 "retrieval" 
 : 
 { 
 object (  Retrieval 
 
) 
 } 
 , 
 "googleSearch" 
 : 
 { 
 object (  GoogleSearch 
 
) 
 } 
 , 
 "googleSearchRetrieval" 
 : 
 { 
 object (  GoogleSearchRetrieval 
 
) 
 } 
 , 
 "googleMaps" 
 : 
 { 
 object (  GoogleMaps 
 
) 
 } 
 , 
 "enterpriseWebSearch" 
 : 
 { 
 object (  EnterpriseWebSearch 
 
) 
 } 
 , 
 "codeExecution" 
 : 
 { 
 object ( CodeExecution 
) 
 } 
 , 
 "urlContext" 
 : 
 { 
 object ( UrlContext 
) 
 } 
 , 
 "computerUse" 
 : 
 { 
 object (  ComputerUse 
 
) 
 } 
 }
    Fields
    functionDeclarations[]

    object ( FunctionDeclaration )

    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.
    retrieval

    object ( Retrieval )

    Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
    googleSearch

    object ( GoogleSearch )

    Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
    googleSearchRetrieval
    (deprecated)

    object ( GoogleSearchRetrieval )

    Optional. Specialized retrieval tool that is powered by Google Search.
    googleMaps

    object ( GoogleMaps )

    Optional. GoogleMaps tool type. Tool to support Google Maps in Model.
    enterpriseWebSearch

    object ( EnterpriseWebSearch )

    Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
    codeExecution

    object ( CodeExecution )

    Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
    urlContext

    object ( UrlContext )

    Optional. Tool to support URL context retrieval.
    computerUse

    object ( ComputerUse )

    Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.

    FunctionDeclaration

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "parameters" 
 : 
 { 
 object (  Schema 
 
) 
 } 
 , 
 "parametersJsonSchema" 
 : 
 value 
 , 
 "response" 
 : 
 { 
 object (  Schema 
 
) 
 } 
 , 
 "responseJsonSchema" 
 : 
 value 
 }
    Fields
    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.
    description

    string

    Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
    parameters

    object ( Schema )

    Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1
    parametersJsonSchema

    value ( Value format)

    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": { "type": "integer" }
  },
  "additionalProperties": false,
  "required": ["name", "age"],
  "propertyOrdering": ["name", "age"]
}

    This field is mutually exclusive with parameters .
    response

    object ( Schema )

    Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.
    responseJsonSchema

    value ( Value format)

    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 .

    Schema

    JSON representation 
     { 
 "type" 
 : 
 enum ( Type 
) 
 , 
 "format" 
 : 
 string 
 , 
 "title" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "nullable" 
 : 
 boolean 
 , 
 "default" 
 : 
 value 
 , 
 "items" 
 : 
 { 
 object (  Schema 
 
) 
 } 
 , 
 "minItems" 
 : 
 string 
 , 
 "maxItems" 
 : 
 string 
 , 
 "enum" 
 : 
 [ 
 string 
 ] 
 , 
 "properties" 
 : 
 { 
 string 
 : 
 { 
 object (  Schema 
 
) 
 } 
 , 
 ... 
 } 
 , 
 "propertyOrdering" 
 : 
 [ 
 string 
 ] 
 , 
 "required" 
 : 
 [ 
 string 
 ] 
 , 
 "minProperties" 
 : 
 string 
 , 
 "maxProperties" 
 : 
 string 
 , 
 "minimum" 
 : 
 number 
 , 
 "maximum" 
 : 
 number 
 , 
 "minLength" 
 : 
 string 
 , 
 "maxLength" 
 : 
 string 
 , 
 "pattern" 
 : 
 string 
 , 
 "example" 
 : 
 value 
 , 
 "anyOf" 
 : 
 [ 
 { 
 object (  Schema 
 
) 
 } 
 ] 
 , 
 "additionalProperties" 
 : 
 value 
 , 
 "ref" 
 : 
 string 
 , 
 "defs" 
 : 
 { 
 string 
 : 
 { 
 object (  Schema 
 
) 
 } 
 , 
 ... 
 } 
 }
    Fields
    type

    enum ( Type )

    Optional. Data type of the schema field.
    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.
    title

    string

    Optional. Title for 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.
    nullable

    boolean

    Optional. Indicates if the value of this field can be null.
    default

    value ( Value format)

    Optional. Default value to use if the field is not specified.
    items

    object ( Schema )

    Optional. If type is ARRAY , items specifies the schema of elements in the array.
    minItems

    string ( int64 format)

    Optional. If type is ARRAY , min_items specifies the minimum number of items in an array.
    maxItems

    string ( int64 format)

    Optional. If type is ARRAY , max_items specifies the maximum number of items in an array.
    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"]}

    properties

    map (key: string, value: object ( Schema ))

    Optional. If type is OBJECT , properties is a map of property names to schema definitions for each property of the object.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .
    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.
    required[]

    string

    Optional. If type is OBJECT , required lists the names of properties that must be present.
    minProperties

    string ( int64 format)

    Optional. If type is OBJECT , min_properties specifies the minimum number of properties that can be provided.
    maxProperties

    string ( int64 format)

    Optional. If type is OBJECT , max_properties specifies the maximum number of properties that can be provided.
    minimum

    number

    Optional. If type is INTEGER or NUMBER , minimum specifies the minimum allowed value.
    maximum

    number

    Optional. If type is INTEGER or NUMBER , maximum specifies the maximum allowed value.
    minLength

    string ( int64 format)

    Optional. If type is STRING , min_length specifies the minimum length of the string.
    maxLength

    string ( int64 format)

    Optional. If type is STRING , max_length specifies the maximum length of the string.
    pattern

    string

    Optional. If type is STRING , pattern specifies a regular expression that the string must match.
    example

    value ( Value format)

    Optional. Example of an instance of this schema.
    anyOf[]

    object ( Schema )

    Optional. The instance must be valid against any (one or more) of the subschemas listed in any_of .
    additionalProperties

    value ( Value format)

    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.
    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

    defs

    map (key: string, value: object ( Schema ))

    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.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

    PropertiesEntry

    JSON representation 
     { 
 "key" 
 : 
 string 
 , 
 "value" 
 : 
 { 
 object (  Schema 
 
) 
 } 
 }
    Fields
    key

    string

    value

    object ( Schema )

    DefsEntry

    JSON representation 
     { 
 "key" 
 : 
 string 
 , 
 "value" 
 : 
 { 
 object (  Schema 
 
) 
 } 
 }
    Fields
    key

    string

    value

    object ( Schema )

    Retrieval

    JSON representation 
     { 
 "disableAttribution" 
 : 
 boolean 
 , 
 // Union field source 
can be only one of the following: 
 "vertexAiSearch" 
 : 
 { 
 object (  VertexAISearch 
 
) 
 } 
 , 
 "vertexRagStore" 
 : 
 { 
 object (  VertexRagStore 
 
) 
 } 
 // End of list of possible types for union field source 
. 
 }
    Fields
    disableAttribution
    (deprecated)

    boolean

    Optional. Deprecated. This option is no longer supported.

    Union field source . The source of the retrieval. source can be only one of the following:
    vertexAiSearch

    object ( VertexAISearch )

    Set to use data source powered by Vertex AI Search.

    vertexRagStore

    object ( VertexRagStore )

    Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.

    VertexAISearch

    JSON representation 
     { 
 "datastore" 
 : 
 string 
 , 
 "engine" 
 : 
 string 
 , 
 "maxResults" 
 : 
 integer 
 , 
 "filter" 
 : 
 string 
 , 
 "dataStoreSpecs" 
 : 
 [ 
 { 
 object (  DataStoreSpec 
 
) 
 } 
 ] 
 }
    Fields
    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}

    maxResults

    integer

    Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
    filter

    string

    Optional. Filter strings to be passed to the search API.
    dataStoreSpecs[]

    object ( DataStoreSpec )

    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.

    DataStoreSpec

    JSON representation 
     { 
 "dataStore" 
 : 
 string 
 , 
 "filter" 
 : 
 string 
 }
    Fields
    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

    VertexRagStore

    JSON representation 
     { 
 "ragCorpora" 
 : 
 [ 
 string 
 ] 
 , 
 "ragResources" 
 : 
 [ 
 { 
 object (  RagResource 
 
) 
 } 
 ] 
 , 
 "ragRetrievalConfig" 
 : 
 { 
 object (  RagRetrievalConfig 
 
) 
 } 
 , 
 "storeContext" 
 : 
 boolean 
 , 
 // Union field _similarity_top_k 
can be only one of the following: 
 "similarityTopK" 
 : 
 integer 
 // End of list of possible types for union field _similarity_top_k 
. 
 // Union field _vector_distance_threshold 
can be only one of the following: 
 "vectorDistanceThreshold" 
 : 
 number 
 // End of list of possible types for union field _vector_distance_threshold 
. 
 }
    Fields
    ragCorpora[]
    (deprecated)

    string

    Optional. Deprecated. Please use rag_resources instead.

    ragResources[]

    object ( RagResource )

    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.

    ragRetrievalConfig

    object ( RagRetrievalConfig )

    Optional. The retrieval config for the Rag query.

    storeContext

    boolean

    Optional. Currently only supported for Gemini Multimodal Live API.

    In Gemini Multimodal Live API, if store_context bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions.

    Union field _similarity_top_k .

    _similarity_top_k can be only one of the following:

    similarityTopK
    (deprecated)

    integer

    Optional. Number of top k results to return from the selected corpora.

    Union field _vector_distance_threshold .

    _vector_distance_threshold can be only one of the following:

    vectorDistanceThreshold
    (deprecated)

    number

    Optional. Only return results with vector distance smaller than the threshold.

    RagResource

    JSON representation 
     { 
 "ragCorpus" 
 : 
 string 
 , 
 "ragFileIds" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    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

    JSON representation 
     { 
 "topK" 
 : 
 integer 
 , 
 "hybridSearch" 
 : 
 { 
 object (  HybridSearch 
 
) 
 } 
 , 
 "filter" 
 : 
 { 
 object (  Filter 
 
) 
 } 
 , 
 "ranking" 
 : 
 { 
 object (  Ranking 
 
) 
 } 
 }
    Fields
    topK

    integer

    Optional. The number of contexts to retrieve.
    hybridSearch

    object ( HybridSearch )

    Optional. Config for Hybrid Search.
    filter

    object ( Filter )

    Optional. Config for filters.
    ranking

    object ( Ranking )

    Optional. Config for ranking and reranking.

    HybridSearch

    JSON representation 
     { 
 // Union field _alpha 
can be only one of the following: 
 "alpha" 
 : 
 number 
 // End of list of possible types for union field _alpha 
. 
 }
    Fields

    Union field _alpha .

    _alpha can be only one of the following:

    alpha

    number

    Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally.

    Filter

    JSON representation 
     { 
 "metadataFilter" 
 : 
 string 
 , 
 // Union field vector_db_threshold 
can be only one of the following: 
 "vectorDistanceThreshold" 
 : 
 number 
 , 
 "vectorSimilarityThreshold" 
 : 
 number 
 // End of list of possible types for union field vector_db_threshold 
. 
 }
    Fields
    metadataFilter

    string

    Optional. String for metadata filtering.

    Union field vector_db_threshold . Filter contexts retrieved from the vector DB based on either vector distance or vector similarity. vector_db_threshold can be only one of the following:
    vectorDistanceThreshold

    number

    Optional. Only returns contexts with vector distance smaller than the threshold.

    vectorSimilarityThreshold

    number

    Optional. Only returns contexts with vector similarity larger than the threshold.

    Ranking

    JSON representation 
     { 
 // Union field ranking_config 
can be only one of the following: 
 "rankService" 
 : 
 { 
 object (  RankService 
 
) 
 } 
 , 
 "llmRanker" 
 : 
 { 
 object (  LlmRanker 
 
) 
 } 
 // End of list of possible types for union field ranking_config 
. 
 }
    Fields
    Union field ranking_config . Config options for ranking. Currently only Rank Service is supported. ranking_config can be only one of the following:
    rankService

    object ( RankService )

    Optional. Config for Rank Service.

    llmRanker

    object ( LlmRanker )

    Optional. Config for LlmRanker.

    RankService

    JSON representation 
     { 
 // Union field _model_name 
can be only one of the following: 
 "modelName" 
 : 
 string 
 // End of list of possible types for union field _model_name 
. 
 }
    Fields

    Union field _model_name .

    _model_name can be only one of the following:

    modelName

    string

    Optional. The model name of the rank service. Format: semantic-ranker-512@latest

    LlmRanker

    JSON representation 
     { 
 // Union field _model_name 
can be only one of the following: 
 "modelName" 
 : 
 string 
 // End of list of possible types for union field _model_name 
. 
 }
    Fields

    Union field _model_name .

    _model_name can be only one of the following:

    modelName

    string

    Optional. The model name used for ranking. See Supported models .

    GoogleSearch

    JSON representation 
     { 
 "excludeDomains" 
 : 
 [ 
 string 
 ] 
 , 
 // Union field _blocking_confidence 
can be only one of the following: 
 "blockingConfidence" 
 : 
 enum ( PhishBlockThreshold 
) 
 // End of list of possible types for union field _blocking_confidence 
. 
 }
    Fields
    excludeDomains[]

    string

    Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].

    Union field _blocking_confidence .

    _blocking_confidence can be only one of the following:

    blockingConfidence

    enum ( PhishBlockThreshold )

    Optional. Sites with confidence level chosen & above this value will be blocked from the search results.

    GoogleSearchRetrieval

    JSON representation 
     { 
 "dynamicRetrievalConfig" 
 : 
 { 
 object (  DynamicRetrievalConfig 
 
) 
 } 
 }
    Fields
    dynamicRetrievalConfig

    object ( DynamicRetrievalConfig )

    Specifies the dynamic retrieval configuration for the given source.

    DynamicRetrievalConfig

    JSON representation 
     { 
 "mode" 
 : 
 enum ( Mode 
) 
 , 
 // Union field _dynamic_threshold 
can be only one of the following: 
 "dynamicThreshold" 
 : 
 number 
 // End of list of possible types for union field _dynamic_threshold 
. 
 }
    Fields
    mode

    enum ( Mode )

    The mode of the predictor to be used in dynamic retrieval.

    Union field _dynamic_threshold .

    _dynamic_threshold can be only one of the following:

    dynamicThreshold

    number

    Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.

    GoogleMaps

    JSON representation 
     { 
 "enableWidget" 
 : 
 boolean 
 }
    Fields
    enableWidget

    boolean

    Optional. If true, include the widget context token in the response.

    EnterpriseWebSearch

    JSON representation 
     { 
 "excludeDomains" 
 : 
 [ 
 string 
 ] 
 , 
 // Union field _blocking_confidence 
can be only one of the following: 
 "blockingConfidence" 
 : 
 enum ( PhishBlockThreshold 
) 
 // End of list of possible types for union field _blocking_confidence 
. 
 }
    Fields
    excludeDomains[]

    string

    Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.

    Union field _blocking_confidence .

    _blocking_confidence can be only one of the following:

    blockingConfidence

    enum ( PhishBlockThreshold )

    Optional. Sites with confidence level chosen & above this value will be blocked from the search results.

    ComputerUse

    JSON representation 
     { 
 "environment" 
 : 
 enum ( Environment 
) 
 , 
 "excludedPredefinedFunctions" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    environment

    enum ( Environment )

    Required. The environment being operated.
    excludedPredefinedFunctions[]

    string

    Optional. By default, predefined functions are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.

    GenerationConfig

    JSON representation 
     { 
 "stopSequences" 
 : 
 [ 
 string 
 ] 
 , 
 "responseMimeType" 
 : 
 string 
 , 
 "responseModalities" 
 : 
 [ 
 enum ( Modality 
) 
 ] 
 , 
 "thinkingConfig" 
 : 
 { 
 object (  ThinkingConfig 
 
) 
 } 
 , 
 "modelConfig" 
 : 
 { 
 object (  ModelConfig 
 
) 
 } 
 , 
 // Union field _temperature 
can be only one of the following: 
 "temperature" 
 : 
 number 
 // End of list of possible types for union field _temperature 
. 
 // Union field _top_p 
can be only one of the following: 
 "topP" 
 : 
 number 
 // End of list of possible types for union field _top_p 
. 
 // Union field _top_k 
can be only one of the following: 
 "topK" 
 : 
 number 
 // End of list of possible types for union field _top_k 
. 
 // Union field _candidate_count 
can be only one of the following: 
 "candidateCount" 
 : 
 integer 
 // End of list of possible types for union field _candidate_count 
. 
 // Union field _max_output_tokens 
can be only one of the following: 
 "maxOutputTokens" 
 : 
 integer 
 // End of list of possible types for union field _max_output_tokens 
. 
 // Union field _response_logprobs 
can be only one of the following: 
 "responseLogprobs" 
 : 
 boolean 
 // End of list of possible types for union field _response_logprobs 
. 
 // Union field _logprobs 
can be only one of the following: 
 "logprobs" 
 : 
 integer 
 // End of list of possible types for union field _logprobs 
. 
 // Union field _presence_penalty 
can be only one of the following: 
 "presencePenalty" 
 : 
 number 
 // End of list of possible types for union field _presence_penalty 
. 
 // Union field _frequency_penalty 
can be only one of the following: 
 "frequencyPenalty" 
 : 
 number 
 // End of list of possible types for union field _frequency_penalty 
. 
 // Union field _seed 
can be only one of the following: 
 "seed" 
 : 
 integer 
 // End of list of possible types for union field _seed 
. 
 // Union field _response_schema 
can be only one of the following: 
 "responseSchema" 
 : 
 { 
 object (  Schema 
 
) 
 } 
 // End of list of possible types for union field _response_schema 
. 
 // Union field _response_json_schema 
can be only one of the following: 
 "responseJsonSchema" 
 : 
 value 
 // End of list of possible types for union field _response_json_schema 
. 
 // Union field _routing_config 
can be only one of the following: 
 "routingConfig" 
 : 
 { 
 object (  RoutingConfig 
 
) 
 } 
 // End of list of possible types for union field _routing_config 
. 
 // Union field _audio_timestamp 
can be only one of the following: 
 "audioTimestamp" 
 : 
 boolean 
 // End of list of possible types for union field _audio_timestamp 
. 
 // Union field _media_resolution 
can be only one of the following: 
 "mediaResolution" 
 : 
 enum ( MediaResolution 
) 
 // End of list of possible types for union field _media_resolution 
. 
 // Union field _speech_config 
can be only one of the following: 
 "speechConfig" 
 : 
 { 
 object (  SpeechConfig 
 
) 
 } 
 // End of list of possible types for union field _speech_config 
. 
 // Union field _enable_affective_dialog 
can be only one of the following: 
 "enableAffectiveDialog" 
 : 
 boolean 
 // End of list of possible types for union field _enable_affective_dialog 
. 
 // Union field _image_config 
can be only one of the following: 
 "imageConfig" 
 : 
 { 
 object (  ImageConfig 
 
) 
 } 
 // End of list of possible types for union field _image_config 
. 
 }
    Fields
    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.

    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.

    responseModalities[]

    enum ( Modality )

    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.

    thinkingConfig

    object ( ThinkingConfig )

    Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.

    modelConfig
    (deprecated)

    object ( ModelConfig )

    Optional. Config for model selection.

    Union field _temperature .

    _temperature can be only one of the following:

    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].

    Union field _top_p .

    _top_p can be only one of the following:

    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 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.

    Union field _top_k .

    _top_k can be only one of the following:

    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 next word from the 40 most likely words.

    Union field _candidate_count .

    _candidate_count can be only one of the following:

    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.

    Union field _max_output_tokens .

    _max_output_tokens can be only one of the following:

    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.

    Union field _response_logprobs .

    _response_logprobs can be only one of the following:

    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.

    Union field _logprobs .

    _logprobs can be only one of the following:

    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.

    Union field _presence_penalty .

    _presence_penalty can be only one of the following:

    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].

    Union field _frequency_penalty .

    _frequency_penalty can be only one of the following:

    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].

    Union field _seed .

    _seed can be only one of the following:

    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.

    Union field _response_schema .

    _response_schema can be only one of the following:

    responseSchema

    object ( Schema )

    Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the OpenAPI 3.0 schema object object.

    When this field is set, you must also set the response_mime_type to application/json .

    Union field _response_json_schema .

    _response_json_schema can be only one of the following:

    responseJsonSchema

    value ( Value format)

    Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to application/json .

    Union field _routing_config .

    _routing_config can be only one of the following:

    routingConfig

    object ( RoutingConfig )

    Optional. Routing configuration.

    Union field _audio_timestamp .

    _audio_timestamp can be only one of the following:

    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.

    Union field _media_resolution .

    _media_resolution can be only one of the following:

    mediaResolution

    enum ( MediaResolution )

    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.

    Union field _speech_config .

    _speech_config can be only one of the following:

    speechConfig

    object ( SpeechConfig )

    Optional. The speech generation config.

    Union field _enable_affective_dialog .

    _enable_affective_dialog can be only one of the following:

    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.

    Union field _image_config .

    _image_config can be only one of the following:

    imageConfig

    object ( ImageConfig )

    Optional. Config for image generation features.

    RoutingConfig

    JSON representation 
     { 
 // Union field routing_config 
can be only one of the following: 
 "autoMode" 
 : 
 { 
 object (  AutoRoutingMode 
 
) 
 } 
 , 
 "manualMode" 
 : 
 { 
 object (  ManualRoutingMode 
 
) 
 } 
 // End of list of possible types for union field routing_config 
. 
 }
    Fields
    Union field routing_config . The routing mode for the request. routing_config can be only one of the following:
    autoMode

    object ( AutoRoutingMode )

    In this mode, the model is selected automatically based on the content of the request.

    manualMode

    object ( ManualRoutingMode )

    In this mode, the model is specified manually.

    AutoRoutingMode

    JSON representation 
     { 
 // Union field _model_routing_preference 
can be only one of the following: 
 "modelRoutingPreference" 
 : 
 enum ( ModelRoutingPreference 
) 
 // End of list of possible types for union field _model_routing_preference 
. 
 }
    Fields

    Union field _model_routing_preference .

    _model_routing_preference can be only one of the following:

    modelRoutingPreference

    enum ( ModelRoutingPreference )

    The model routing preference.

    ManualRoutingMode

    JSON representation 
     { 
 // Union field _model_name 
can be only one of the following: 
 "modelName" 
 : 
 string 
 // End of list of possible types for union field _model_name 
. 
 }
    Fields

    Union field _model_name .

    _model_name can be only one of the following:

    modelName

    string

    The name of the model to use. Only public LLM models are accepted.

    SpeechConfig

    JSON representation 
     { 
 "voiceConfig" 
 : 
 { 
 object (  VoiceConfig 
 
) 
 } 
 , 
 "languageCode" 
 : 
 string 
 , 
 "multiSpeakerVoiceConfig" 
 : 
 { 
 object (  MultiSpeakerVoiceConfig 
 
) 
 } 
 }
    Fields
    voiceConfig

    object ( VoiceConfig )

    The configuration for the voice to use.
    languageCode

    string

    Optional. The language code (ISO 639-1) for the speech synthesis.
    multiSpeakerVoiceConfig

    object ( MultiSpeakerVoiceConfig )

    The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with voice_config .

    VoiceConfig

    JSON representation 
     { 
 // Union field voice_config 
can be only one of the following: 
 "prebuiltVoiceConfig" 
 : 
 { 
 object (  PrebuiltVoiceConfig 
 
) 
 } 
 , 
 "replicatedVoiceConfig" 
 : 
 { 
 object (  ReplicatedVoiceConfig 
 
) 
 } 
 // End of list of possible types for union field voice_config 
. 
 }
    Fields
    Union field voice_config . The configuration for the speaker to use. voice_config can be only one of the following:
    prebuiltVoiceConfig

    object ( PrebuiltVoiceConfig )

    The configuration for a prebuilt voice.

    replicatedVoiceConfig

    object ( ReplicatedVoiceConfig )

    Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.

    PrebuiltVoiceConfig

    JSON representation 
     { 
 // Union field _voice_name 
can be only one of the following: 
 "voiceName" 
 : 
 string 
 // End of list of possible types for union field _voice_name 
. 
 }
    Fields

    Union field _voice_name .

    _voice_name can be only one of the following:

    voiceName

    string

    The name of the prebuilt voice to use.

    ReplicatedVoiceConfig

    JSON representation 
     { 
 "mimeType" 
 : 
 string 
 , 
 "voiceSampleAudio" 
 : 
 string 
 }
    Fields
    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 ( bytes format)

    Optional. The sample of the custom voice.

    A base64-encoded string.

    MultiSpeakerVoiceConfig

    JSON representation 
     { 
 "speakerVoiceConfigs" 
 : 
 [ 
 { 
 object (  SpeakerVoiceConfig 
 
) 
 } 
 ] 
 }
    Fields
    speakerVoiceConfigs[]

    object ( SpeakerVoiceConfig )

    Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.

    SpeakerVoiceConfig

    JSON representation 
     { 
 "speaker" 
 : 
 string 
 , 
 "voiceConfig" 
 : 
 { 
 object (  VoiceConfig 
 
) 
 } 
 }
    Fields
    speaker

    string

    Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
    voiceConfig

    object ( VoiceConfig )

    Required. The configuration for the voice of this speaker.

    ThinkingConfig

    JSON representation 
     { 
 // Union field _include_thoughts 
can be only one of the following: 
 "includeThoughts" 
 : 
 boolean 
 // End of list of possible types for union field _include_thoughts 
. 
 // Union field _thinking_budget 
can be only one of the following: 
 "thinkingBudget" 
 : 
 integer 
 // End of list of possible types for union field _thinking_budget 
. 
 // Union field _thinking_level 
can be only one of the following: 
 "thinkingLevel" 
 : 
 enum ( ThinkingLevel 
) 
 // End of list of possible types for union field _thinking_level 
. 
 }
    Fields

    Union field _include_thoughts .

    _include_thoughts can be only one of the following:

    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.

    Union field _thinking_budget .

    _thinking_budget can be only one of the following:

    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.

    Union field _thinking_level .

    _thinking_level can be only one of the following:

    thinkingLevel

    enum ( ThinkingLevel )

    Optional. The number of thoughts tokens that the model should generate.

    ModelConfig

    JSON representation 
     { 
 "featureSelectionPreference" 
 : 
 enum ( FeatureSelectionPreference 
) 
 }
    Fields
    featureSelectionPreference

    enum ( FeatureSelectionPreference )

    Required. Feature selection preference.

    ImageConfig

    JSON representation 
     { 
 // Union field _image_output_options 
can be only one of the following: 
 "imageOutputOptions" 
 : 
 { 
 object (  ImageOutputOptions 
 
) 
 } 
 // End of list of possible types for union field _image_output_options 
. 
 // Union field _aspect_ratio 
can be only one of the following: 
 "aspectRatio" 
 : 
 string 
 // End of list of possible types for union field _aspect_ratio 
. 
 // Union field _person_generation 
can be only one of the following: 
 "personGeneration" 
 : 
 enum ( PersonGeneration 
) 
 // End of list of possible types for union field _person_generation 
. 
 // Union field _image_size 
can be only one of the following: 
 "imageSize" 
 : 
 string 
 // End of list of possible types for union field _image_size 
. 
 }
    Fields

    Union field _image_output_options .

    _image_output_options can be only one of the following:

    imageOutputOptions

    object ( ImageOutputOptions )

    Optional. The image output format for generated images.

    Union field _aspect_ratio .

    _aspect_ratio can be only one of the following:

    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"

    Union field _person_generation .

    _person_generation can be only one of the following:

    personGeneration

    enum ( PersonGeneration )

    Optional. Controls whether the model can generate people.

    Union field _image_size .

    _image_size can be only one of the following:

    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 .

    ImageOutputOptions

    JSON representation 
     { 
 // Union field _mime_type 
can be only one of the following: 
 "mimeType" 
 : 
 string 
 // End of list of possible types for union field _mime_type 
. 
 // Union field _compression_quality 
can be only one of the following: 
 "compressionQuality" 
 : 
 integer 
 // End of list of possible types for union field _compression_quality 
. 
 }
    Fields

    Union field _mime_type .

    _mime_type can be only one of the following:

    mimeType

    string

    Optional. The image format that the output should be saved as.

    Union field _compression_quality .

    _compression_quality can be only one of the following:

    compressionQuality

    integer

    Optional. The compression quality of the output image.

    Output Schema

    Response message for PredictionService.CountTokens .

    CountTokensResponse

    JSON representation 
     { 
 "totalTokens" 
 : 
 integer 
 , 
 "totalBillableCharacters" 
 : 
 integer 
 , 
 "promptTokensDetails" 
 : 
 [ 
 { 
 object (  ModalityTokenCount 
 
) 
 } 
 ] 
 }
    Fields
    totalTokens

    integer

    The total number of tokens counted across all instances from the request.
    totalBillableCharacters

    integer

    The total number of billable characters counted across all instances from the request.
    promptTokensDetails[]

    object ( ModalityTokenCount )

    Output only. List of modalities that were processed in the request input.

    ModalityTokenCount

    JSON representation 
     { 
 "modality" 
 : 
 enum ( Modality 
) 
 , 
 "tokenCount" 
 : 
 integer 
 }
    Fields
    modality

    enum ( Modality )

    The modality that this token count applies to.
    tokenCount

    integer

    The number of tokens counted for this modality.

    Tool Annotations

    Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: