Vertex AI API . publishers . models

close()

Close httplib2 connections.

computeTokens(endpoint, body=None, x__xgafv=None)

Return a list of tokens based on the input text.

Args:
  endpoint: string, Required. The name of the Endpoint requested to get lists of tokens and token ids. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for ComputeTokens RPC call.
  "contents": [ # Optional. Input content.
    { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
      "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
        { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
          "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
            "outcome": "A String", # Required. Outcome of the code execution.
            "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
          },
          "executableCode": { # 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. # Optional. Code generated by the model that is meant to be executed.
            "code": "A String", # Required. The code to be executed.
            "language": "A String", # Required. Programming language of the `code`.
          },
          "fileData": { # URI based data. # Optional. URI based data.
            "displayName": "A 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": "A String", # Required. URI.
            "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
          },
          "functionCall": { # 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. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
            "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
              "a_key": "", # Properties of the object.
            },
            "id": "A 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": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
          },
          "functionResponse": { # 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. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
            "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
            "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
            "response": { # 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.
              "a_key": "", # Properties of the object.
            },
          },
          "inlineData": { # Content blob. # Optional. Inlined bytes data.
            "data": "A String", # Required. Raw bytes.
            "displayName": "A 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": "A String", # Required. The IANA standard MIME type of the source data.
          },
          "text": "A String", # Optional. Text part (can be code).
          "thought": True or False, # Optional. Indicates if the part is thought from the model.
          "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
          "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
            "endOffset": "A String", # Optional. The end offset of the video.
            "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
            "startOffset": "A String", # Optional. The start offset of the video.
          },
        },
      ],
      "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
    },
  ],
  "instances": [ # Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models.
    "",
  ],
  "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for ComputeTokens RPC call.
  "tokensInfo": [ # Lists of tokens info from the input. A ComputeTokensRequest could have multiple instances with a prompt in each instance. We also need to return lists of tokens info for the request with multiple instances.
    { # Tokens info with a list of tokens and the corresponding list of token ids.
      "role": "A String", # Optional. Optional fields for the role from the corresponding Content.
      "tokenIds": [ # A list of token ids from the input.
        "A String",
      ],
      "tokens": [ # A list of tokens from the input.
        "A String",
      ],
    },
  ],
}

countTokens(endpoint, body=None, x__xgafv=None)

Perform a token counting.

Args:
  endpoint: string, Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for PredictionService.CountTokens.
  "contents": [ # Optional. Input content.
    { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
      "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
        { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
          "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
            "outcome": "A String", # Required. Outcome of the code execution.
            "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
          },
          "executableCode": { # 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. # Optional. Code generated by the model that is meant to be executed.
            "code": "A String", # Required. The code to be executed.
            "language": "A String", # Required. Programming language of the `code`.
          },
          "fileData": { # URI based data. # Optional. URI based data.
            "displayName": "A 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": "A String", # Required. URI.
            "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
          },
          "functionCall": { # 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. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
            "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
              "a_key": "", # Properties of the object.
            },
            "id": "A 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": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
          },
          "functionResponse": { # 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. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
            "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
            "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
            "response": { # 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.
              "a_key": "", # Properties of the object.
            },
          },
          "inlineData": { # Content blob. # Optional. Inlined bytes data.
            "data": "A String", # Required. Raw bytes.
            "displayName": "A 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": "A String", # Required. The IANA standard MIME type of the source data.
          },
          "text": "A String", # Optional. Text part (can be code).
          "thought": True or False, # Optional. Indicates if the part is thought from the model.
          "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
          "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
            "endOffset": "A String", # Optional. The end offset of the video.
            "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
            "startOffset": "A String", # Optional. The start offset of the video.
          },
        },
      ],
      "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
    },
  ],
  "generationConfig": { # Generation config. # Optional. Generation config that the model will use to generate the response.
    "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
    "candidateCount": 42, # Optional. Number of candidates to generate.
    "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
    "frequencyPenalty": 3.14, # Optional. Frequency penalties.
    "logprobs": 42, # Optional. Logit probabilities.
    "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
    "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
    "modelConfig": { # Config for model selection. # Optional. Config for model selection.
      "featureSelectionPreference": "A String", # Required. Feature selection preference.
    },
    "presencePenalty": 3.14, # Optional. Positive penalties.
    "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
    "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
    "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
    "responseModalities": [ # Optional. The modalities of the response.
      "A String",
    ],
    "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
      "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
      "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
        # Object with schema name: GoogleCloudAiplatformV1beta1Schema
      ],
      "default": "", # Optional. Default value of the data.
      "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
        "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
      },
      "description": "A String", # Optional. The description of the data.
      "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
        "A String",
      ],
      "example": "", # Optional. Example of the object. Will only populated when the object is the root.
      "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
      "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
      "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
      "maxLength": "A String", # Optional. Maximum length of the Type.STRING
      "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
      "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
      "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
      "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
      "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
      "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
      "nullable": True or False, # Optional. Indicates if the value may be null.
      "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
      "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
        "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
      },
      "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
        "A String",
      ],
      "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `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": [ # Optional. Required properties of Type.OBJECT.
        "A String",
      ],
      "title": "A String", # Optional. The title of the Schema.
      "type": "A String", # Optional. The type of the data.
    },
    "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
      "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
        "modelRoutingPreference": "A String", # The model routing preference.
      },
      "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
        "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
      },
    },
    "seed": 42, # Optional. Seed.
    "speechConfig": { # The speech generation config. # Optional. The speech generation config.
      "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
      "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
        "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
          "voiceName": "A String", # The name of the preset voice to use.
        },
      },
    },
    "stopSequences": [ # Optional. Stop sequences.
      "A String",
    ],
    "temperature": 3.14, # Optional. Controls the randomness of predictions.
    "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
      "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
      "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
    },
    "topK": 3.14, # Optional. If specified, top-k sampling will be used.
    "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
  },
  "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.
    "",
  ],
  "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`
  "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # 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.
    "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
      { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
        "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
          "outcome": "A String", # Required. Outcome of the code execution.
          "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
        },
        "executableCode": { # 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. # Optional. Code generated by the model that is meant to be executed.
          "code": "A String", # Required. The code to be executed.
          "language": "A String", # Required. Programming language of the `code`.
        },
        "fileData": { # URI based data. # Optional. URI based data.
          "displayName": "A 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": "A String", # Required. URI.
          "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
        },
        "functionCall": { # 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. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
          "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
            "a_key": "", # Properties of the object.
          },
          "id": "A 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": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
        },
        "functionResponse": { # 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. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
          "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
          "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
          "response": { # 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.
            "a_key": "", # Properties of the object.
          },
        },
        "inlineData": { # Content blob. # Optional. Inlined bytes data.
          "data": "A String", # Required. Raw bytes.
          "displayName": "A 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": "A String", # Required. The IANA standard MIME type of the source data.
        },
        "text": "A String", # Optional. Text part (can be code).
        "thought": True or False, # Optional. Indicates if the part is thought from the model.
        "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
        "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
          "endOffset": "A String", # Optional. The end offset of the video.
          "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
          "startOffset": "A String", # Optional. The start offset of the video.
        },
      },
    ],
    "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
  },
  "tools": [ # 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.
    { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
      "codeExecution": { # 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. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
      },
      "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
        "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
          "A String",
        ],
      },
      "functionDeclarations": [ # 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.
        { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.
          "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
          "name": "A 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 and dashes, with a maximum length of 64.
          "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # 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
            "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
            "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
              # Object with schema name: GoogleCloudAiplatformV1beta1Schema
            ],
            "default": "", # Optional. Default value of the data.
            "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
            },
            "description": "A String", # Optional. The description of the data.
            "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
              "A String",
            ],
            "example": "", # Optional. Example of the object. Will only populated when the object is the root.
            "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
            "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
            "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
            "maxLength": "A String", # Optional. Maximum length of the Type.STRING
            "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
            "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
            "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
            "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
            "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
            "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
            "nullable": True or False, # Optional. Indicates if the value may be null.
            "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
            "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
            },
            "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
              "A String",
            ],
            "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `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": [ # Optional. Required properties of Type.OBJECT.
              "A String",
            ],
            "title": "A String", # Optional. The title of the Schema.
            "type": "A String", # Optional. The type of the data.
          },
          "parametersJsonSchema": "", # 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": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # 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.
            "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
            "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
              # Object with schema name: GoogleCloudAiplatformV1beta1Schema
            ],
            "default": "", # Optional. Default value of the data.
            "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
            },
            "description": "A String", # Optional. The description of the data.
            "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
              "A String",
            ],
            "example": "", # Optional. Example of the object. Will only populated when the object is the root.
            "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
            "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
            "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
            "maxLength": "A String", # Optional. Maximum length of the Type.STRING
            "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
            "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
            "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
            "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
            "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
            "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
            "nullable": True or False, # Optional. Indicates if the value may be null.
            "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
            "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
            },
            "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
              "A String",
            ],
            "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `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": [ # Optional. Required properties of Type.OBJECT.
              "A String",
            ],
            "title": "A String", # Optional. The title of the Schema.
            "type": "A String", # Optional. The type of the data.
          },
          "responseJsonSchema": "", # 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`.
        },
      ],
      "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model.
        "enableWidget": True or False, # Optional. If true, include the widget context token in the response.
      },
      "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
        "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
          "A String",
        ],
      },
      "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search.
        "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
          "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
          "mode": "A String", # The mode of the predictor to be used in dynamic retrieval.
        },
      },
      "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # 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.
        "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
        "externalApi": { # 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. # Use data source powered by external API for grounding.
          "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead.
            "apiKeyConfig": { # The API secret. # The API secret.
              "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
              "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set.
            },
          },
          "apiSpec": "A String", # The API spec that the external API implements.
          "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API.
            "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
              "apiKeySecret": "A 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": "A String", # Optional. The API key to be used in the request directly.
              "httpElementLocation": "A String", # Optional. The location of the API key.
              "name": "A 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": "A String", # Type of auth scheme.
            "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth.
              "serviceAccount": "A 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": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth.
              "credentialSecret": "A 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": { # Config for user oauth. # Config for user oauth.
              "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
              "serviceAccount": "A 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": { # Config for user OIDC auth. # Config for user OIDC auth.
              "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
              "serviceAccount": "A 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": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API.
            "index": "A String", # The ElasticSearch index to use.
            "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param.
            "searchTemplate": "A String", # The ElasticSearch search template to use.
          },
          "endpoint": "A 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": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API.
          },
        },
        "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
          "dataStoreSpecs": [ # 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.
            { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec
              "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
              "filter": "A 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": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
          "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
          "filter": "A String", # Optional. Filter strings to be passed to the search API.
          "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
        },
        "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
          "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
            "A String",
          ],
          "ragResources": [ # 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.
            { # The definition of the Rag resource.
              "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
              "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
                "A String",
              ],
            },
          ],
          "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
            "filter": { # Config for filters. # Optional. Config for filters.
              "metadataFilter": "A String", # Optional. String for metadata filtering.
              "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
              "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
            },
            "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search.
              "alpha": 3.14, # 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.
            },
            "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking.
              "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker.
                "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
              },
              "rankService": { # Config for Rank Service. # Optional. Config for Rank Service.
                "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`
              },
            },
            "topK": 42, # Optional. The number of contexts to retrieve.
          },
          "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora.
          "storeContext": True or False, # 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.
          "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
        },
      },
      "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval.
      },
    },
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for PredictionService.CountTokens.
  "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input.
    { # Represents token counting info for a single modality.
      "modality": "A String", # The modality associated with this token count.
      "tokenCount": 42, # Number of tokens.
    },
  ],
  "totalBillableCharacters": 42, # The total number of billable characters counted across all instances from the request.
  "totalTokens": 42, # The total number of tokens counted across all instances from the request.
}

fetchPredictOperation(endpoint, body=None, x__xgafv=None)

Fetch an asynchronous online prediction operation.

Args:
  endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for PredictionService.FetchPredictOperation.
  "operationName": "A String", # Required. The server-assigned name for the operation.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}

generateContent(model, body=None, x__xgafv=None)

Generate content with multimodal inputs.

Args:
  model: string, Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for [PredictionService.GenerateContent].
  "cachedContent": "A String", # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}`
  "contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.
    { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
      "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
        { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
          "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
            "outcome": "A String", # Required. Outcome of the code execution.
            "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
          },
          "executableCode": { # 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. # Optional. Code generated by the model that is meant to be executed.
            "code": "A String", # Required. The code to be executed.
            "language": "A String", # Required. Programming language of the `code`.
          },
          "fileData": { # URI based data. # Optional. URI based data.
            "displayName": "A 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": "A String", # Required. URI.
            "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
          },
          "functionCall": { # 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. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
            "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
              "a_key": "", # Properties of the object.
            },
            "id": "A 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": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
          },
          "functionResponse": { # 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. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
            "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
            "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
            "response": { # 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.
              "a_key": "", # Properties of the object.
            },
          },
          "inlineData": { # Content blob. # Optional. Inlined bytes data.
            "data": "A String", # Required. Raw bytes.
            "displayName": "A 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": "A String", # Required. The IANA standard MIME type of the source data.
          },
          "text": "A String", # Optional. Text part (can be code).
          "thought": True or False, # Optional. Indicates if the part is thought from the model.
          "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
          "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
            "endOffset": "A String", # Optional. The end offset of the video.
            "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
            "startOffset": "A String", # Optional. The start offset of the video.
          },
        },
      ],
      "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
    },
  ],
  "generationConfig": { # Generation config. # Optional. Generation config.
    "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
    "candidateCount": 42, # Optional. Number of candidates to generate.
    "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
    "frequencyPenalty": 3.14, # Optional. Frequency penalties.
    "logprobs": 42, # Optional. Logit probabilities.
    "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
    "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
    "modelConfig": { # Config for model selection. # Optional. Config for model selection.
      "featureSelectionPreference": "A String", # Required. Feature selection preference.
    },
    "presencePenalty": 3.14, # Optional. Positive penalties.
    "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
    "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
    "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
    "responseModalities": [ # Optional. The modalities of the response.
      "A String",
    ],
    "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
      "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
      "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
        # Object with schema name: GoogleCloudAiplatformV1beta1Schema
      ],
      "default": "", # Optional. Default value of the data.
      "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
        "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
      },
      "description": "A String", # Optional. The description of the data.
      "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
        "A String",
      ],
      "example": "", # Optional. Example of the object. Will only populated when the object is the root.
      "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
      "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
      "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
      "maxLength": "A String", # Optional. Maximum length of the Type.STRING
      "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
      "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
      "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
      "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
      "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
      "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
      "nullable": True or False, # Optional. Indicates if the value may be null.
      "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
      "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
        "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
      },
      "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
        "A String",
      ],
      "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `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": [ # Optional. Required properties of Type.OBJECT.
        "A String",
      ],
      "title": "A String", # Optional. The title of the Schema.
      "type": "A String", # Optional. The type of the data.
    },
    "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
      "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
        "modelRoutingPreference": "A String", # The model routing preference.
      },
      "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
        "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
      },
    },
    "seed": 42, # Optional. Seed.
    "speechConfig": { # The speech generation config. # Optional. The speech generation config.
      "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
      "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
        "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
          "voiceName": "A String", # The name of the preset voice to use.
        },
      },
    },
    "stopSequences": [ # Optional. Stop sequences.
      "A String",
    ],
    "temperature": 3.14, # Optional. Controls the randomness of predictions.
    "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
      "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
      "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
    },
    "topK": 3.14, # Optional. If specified, top-k sampling will be used.
    "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
  },
  "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
    "a_key": "A String",
  },
  "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
    "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization.
    "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization.
  },
  "safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
    { # Safety settings.
      "category": "A String", # Required. Harm category.
      "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.
      "threshold": "A String", # Required. The harm block threshold.
    },
  ],
  "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # 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.
    "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
      { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
        "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
          "outcome": "A String", # Required. Outcome of the code execution.
          "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
        },
        "executableCode": { # 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. # Optional. Code generated by the model that is meant to be executed.
          "code": "A String", # Required. The code to be executed.
          "language": "A String", # Required. Programming language of the `code`.
        },
        "fileData": { # URI based data. # Optional. URI based data.
          "displayName": "A 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": "A String", # Required. URI.
          "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
        },
        "functionCall": { # 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. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
          "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
            "a_key": "", # Properties of the object.
          },
          "id": "A 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": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
        },
        "functionResponse": { # 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. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
          "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
          "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
          "response": { # 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.
            "a_key": "", # Properties of the object.
          },
        },
        "inlineData": { # Content blob. # Optional. Inlined bytes data.
          "data": "A String", # Required. Raw bytes.
          "displayName": "A 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": "A String", # Required. The IANA standard MIME type of the source data.
        },
        "text": "A String", # Optional. Text part (can be code).
        "thought": True or False, # Optional. Indicates if the part is thought from the model.
        "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
        "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
          "endOffset": "A String", # Optional. The end offset of the video.
          "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
          "startOffset": "A String", # Optional. The start offset of the video.
        },
      },
    ],
    "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
  },
  "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request.
    "functionCallingConfig": { # Function calling config. # Optional. Function calling config.
      "allowedFunctionNames": [ # Optional. Function names to call. Only set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided.
        "A String",
      ],
      "mode": "A String", # Optional. Function calling mode.
    },
    "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
      "languageCode": "A String", # The language code of the user.
      "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
        "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
        "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
      },
    },
  },
  "tools": [ # 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.
    { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
      "codeExecution": { # 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. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
      },
      "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
        "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
          "A String",
        ],
      },
      "functionDeclarations": [ # 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.
        { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.
          "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
          "name": "A 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 and dashes, with a maximum length of 64.
          "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # 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
            "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
            "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
              # Object with schema name: GoogleCloudAiplatformV1beta1Schema
            ],
            "default": "", # Optional. Default value of the data.
            "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
            },
            "description": "A String", # Optional. The description of the data.
            "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
              "A String",
            ],
            "example": "", # Optional. Example of the object. Will only populated when the object is the root.
            "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
            "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
            "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
            "maxLength": "A String", # Optional. Maximum length of the Type.STRING
            "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
            "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
            "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
            "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
            "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
            "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
            "nullable": True or False, # Optional. Indicates if the value may be null.
            "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
            "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
            },
            "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
              "A String",
            ],
            "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `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": [ # Optional. Required properties of Type.OBJECT.
              "A String",
            ],
            "title": "A String", # Optional. The title of the Schema.
            "type": "A String", # Optional. The type of the data.
          },
          "parametersJsonSchema": "", # 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": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # 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.
            "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
            "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
              # Object with schema name: GoogleCloudAiplatformV1beta1Schema
            ],
            "default": "", # Optional. Default value of the data.
            "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
            },
            "description": "A String", # Optional. The description of the data.
            "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
              "A String",
            ],
            "example": "", # Optional. Example of the object. Will only populated when the object is the root.
            "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
            "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
            "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
            "maxLength": "A String", # Optional. Maximum length of the Type.STRING
            "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
            "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
            "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
            "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
            "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
            "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
            "nullable": True or False, # Optional. Indicates if the value may be null.
            "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
            "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
            },
            "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
              "A String",
            ],
            "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `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": [ # Optional. Required properties of Type.OBJECT.
              "A String",
            ],
            "title": "A String", # Optional. The title of the Schema.
            "type": "A String", # Optional. The type of the data.
          },
          "responseJsonSchema": "", # 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`.
        },
      ],
      "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model.
        "enableWidget": True or False, # Optional. If true, include the widget context token in the response.
      },
      "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
        "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
          "A String",
        ],
      },
      "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search.
        "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
          "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
          "mode": "A String", # The mode of the predictor to be used in dynamic retrieval.
        },
      },
      "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # 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.
        "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
        "externalApi": { # 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. # Use data source powered by external API for grounding.
          "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead.
            "apiKeyConfig": { # The API secret. # The API secret.
              "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
              "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set.
            },
          },
          "apiSpec": "A String", # The API spec that the external API implements.
          "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API.
            "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
              "apiKeySecret": "A 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": "A String", # Optional. The API key to be used in the request directly.
              "httpElementLocation": "A String", # Optional. The location of the API key.
              "name": "A 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": "A String", # Type of auth scheme.
            "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth.
              "serviceAccount": "A 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": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth.
              "credentialSecret": "A 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": { # Config for user oauth. # Config for user oauth.
              "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
              "serviceAccount": "A 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": { # Config for user OIDC auth. # Config for user OIDC auth.
              "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
              "serviceAccount": "A 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": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API.
            "index": "A String", # The ElasticSearch index to use.
            "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param.
            "searchTemplate": "A String", # The ElasticSearch search template to use.
          },
          "endpoint": "A 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": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API.
          },
        },
        "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
          "dataStoreSpecs": [ # 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.
            { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec
              "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
              "filter": "A 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": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
          "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
          "filter": "A String", # Optional. Filter strings to be passed to the search API.
          "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
        },
        "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
          "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
            "A String",
          ],
          "ragResources": [ # 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.
            { # The definition of the Rag resource.
              "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
              "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
                "A String",
              ],
            },
          ],
          "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
            "filter": { # Config for filters. # Optional. Config for filters.
              "metadataFilter": "A String", # Optional. String for metadata filtering.
              "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
              "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
            },
            "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search.
              "alpha": 3.14, # 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.
            },
            "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking.
              "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker.
                "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
              },
              "rankService": { # Config for Rank Service. # Optional. Config for Rank Service.
                "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`
              },
            },
            "topK": 42, # Optional. The number of contexts to retrieve.
          },
          "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora.
          "storeContext": True or False, # 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.
          "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
        },
      },
      "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval.
      },
    },
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for [PredictionService.GenerateContent].
  "candidates": [ # Output only. Generated candidates.
    { # A response candidate generated from the model.
      "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate.
      "citationMetadata": { # A collection of source attributions for a piece of content. # Output only. Source attribution of the generated content.
        "citations": [ # Output only. List of citations.
          { # Source attributions for content.
            "endIndex": 42, # Output only. End index into the content.
            "license": "A String", # Output only. License of the attribution.
            "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution.
              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
            },
            "startIndex": 42, # Output only. Start index into the content.
            "title": "A String", # Output only. Title of the attribution.
            "uri": "A String", # Output only. Url reference of the attribution.
          },
        ],
      },
      "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Output only. Content parts of the candidate.
        "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
          { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
            "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
              "outcome": "A String", # Required. Outcome of the code execution.
              "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
            },
            "executableCode": { # 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. # Optional. Code generated by the model that is meant to be executed.
              "code": "A String", # Required. The code to be executed.
              "language": "A String", # Required. Programming language of the `code`.
            },
            "fileData": { # URI based data. # Optional. URI based data.
              "displayName": "A 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": "A String", # Required. URI.
              "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
            },
            "functionCall": { # 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. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
              "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
                "a_key": "", # Properties of the object.
              },
              "id": "A 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": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
            },
            "functionResponse": { # 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. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
              "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
              "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
              "response": { # 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.
                "a_key": "", # Properties of the object.
              },
            },
            "inlineData": { # Content blob. # Optional. Inlined bytes data.
              "data": "A String", # Required. Raw bytes.
              "displayName": "A 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": "A String", # Required. The IANA standard MIME type of the source data.
            },
            "text": "A String", # Optional. Text part (can be code).
            "thought": True or False, # Optional. Indicates if the part is thought from the model.
            "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
            "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
              "endOffset": "A String", # Optional. The end offset of the video.
              "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
              "startOffset": "A String", # Optional. The start offset of the video.
            },
          },
        ],
        "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
      },
      "finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set.
      "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.
      "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content.
        "googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.
        "groundingChunks": [ # List of supporting references retrieved from specified grounding source.
          { # Grounding chunk.
            "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps.
              "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content.
                "reviewSnippets": [ # Snippets of reviews that are used to generate the answer.
                  { # Encapsulates a review snippet.
                    "googleMapsUri": "A String", # A link to show the review on Google Maps.
                    "reviewId": "A String", # Id of the review referencing the place.
                    "title": "A String", # Title of the review.
                  },
                ],
              },
              "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place.
              "text": "A String", # Text of the place answer.
              "title": "A String", # Title of the place.
              "uri": "A String", # URI reference of the place.
            },
            "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
              "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
              "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
                "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
                  "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
                  "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed.
                },
                "text": "A String", # The content of the chunk.
              },
              "text": "A String", # Text of the attribution.
              "title": "A String", # Title of the attribution.
              "uri": "A String", # URI reference of the attribution.
            },
            "web": { # Chunk from the web. # Grounding chunk from the web.
              "domain": "A String", # Domain of the (original) URI.
              "title": "A String", # Title of the chunk.
              "uri": "A String", # URI reference of the chunk.
            },
          },
        ],
        "groundingSupports": [ # Optional. List of grounding support.
          { # Grounding support.
            "confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored.
              3.14,
            ],
            "groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.
              42,
            ],
            "segment": { # Segment of the content. # Segment of the content this support belongs to.
              "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.
              "partIndex": 42, # Output only. The index of a Part object within its parent Content object.
              "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.
              "text": "A String", # Output only. The text corresponding to the segment from the response.
            },
          },
        ],
        "retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata.
          "googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.
        },
        "retrievalQueries": [ # Optional. Queries executed by the retrieval tools.
          "A String",
        ],
        "searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches.
          "renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview.
          "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple.
        },
        "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.
          { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding.
            "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review).
            "sourceId": "A String", # Id of the place or review.
          },
        ],
        "webSearchQueries": [ # Optional. Web search queries for the following-up web search.
          "A String",
        ],
      },
      "index": 42, # Output only. Index of the candidate.
      "logprobsResult": { # Logprobs Result # Output only. Log-likelihood scores for the response tokens and top tokens
        "chosenCandidates": [ # Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.
          { # Candidate for the logprobs token and score.
            "logProbability": 3.14, # The candidate's log probability.
            "token": "A String", # The candidate's token string value.
            "tokenId": 42, # The candidate's token id value.
          },
        ],
        "topCandidates": [ # Length = total number of decoding steps.
          { # Candidates with top log probabilities at each decoding step.
            "candidates": [ # Sorted by log probability in descending order.
              { # Candidate for the logprobs token and score.
                "logProbability": 3.14, # The candidate's log probability.
                "token": "A String", # The candidate's token string value.
                "tokenId": 42, # The candidate's token id value.
              },
            ],
          },
        ],
      },
      "safetyRatings": [ # Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.
        { # Safety rating corresponding to the generated content.
          "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating.
          "category": "A String", # Output only. Harm category.
          "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold.
          "probability": "A String", # Output only. Harm probability levels in the content.
          "probabilityScore": 3.14, # Output only. Harm probability score.
          "severity": "A String", # Output only. Harm severity levels in the content.
          "severityScore": 3.14, # Output only. Harm severity score.
        },
      ],
      "urlContextMetadata": { # Metadata related to url context retrieval tool. # Output only. Metadata related to url context retrieval tool.
        "urlMetadata": [ # Output only. List of url context.
          { # Context of the a single url retrieval.
            "retrievedUrl": "A String", # Retrieved url by the tool.
            "urlRetrievalStatus": "A String", # Status of the url retrieval.
          },
        ],
      },
    },
  ],
  "createTime": "A String", # Output only. Timestamp when the request is made to the server.
  "modelVersion": "A String", # Output only. The model version used to generate the response.
  "promptFeedback": { # Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations.
    "blockReason": "A String", # Output only. The reason why the prompt was blocked.
    "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked.
    "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category.
      { # Safety rating corresponding to the generated content.
        "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating.
        "category": "A String", # Output only. Harm category.
        "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold.
        "probability": "A String", # Output only. Harm probability levels in the content.
        "probabilityScore": 3.14, # Output only. Harm probability score.
        "severity": "A String", # Output only. Harm severity levels in the content.
        "severityScore": 3.14, # Output only. Harm severity score.
      },
    ],
  },
  "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id.
  "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s).
    "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content.
      { # Represents token counting info for a single modality.
        "modality": "A String", # The modality associated with this token count.
        "tokenCount": 42, # Number of tokens.
      },
    ],
    "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request.
    "candidatesTokenCount": 42, # The total number of tokens in the generated candidates.
    "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates.
      { # Represents token counting info for a single modality.
        "modality": "A String", # The modality associated with this token count.
        "tokenCount": 42, # Number of tokens.
      },
    ],
    "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content.
    "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt.
      { # Represents token counting info for a single modality.
        "modality": "A String", # The modality associated with this token count.
        "tokenCount": 42, # Number of tokens.
      },
    ],
    "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable.
    "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.
    "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
      { # Represents token counting info for a single modality.
        "modality": "A String", # The modality associated with this token count.
        "tokenCount": 42, # Number of tokens.
      },
    ],
    "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.
    "trafficType": "A String", # Output only. The traffic type for this request.
  },
}

get(name, huggingFaceToken=None, includeEquivalentModelGardenModelDeploymentConfigs=None, isHuggingFaceModel=None, languageCode=None, view=None, x__xgafv=None)

Gets a Model Garden publisher model.

Args:
  name: string, Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}` (required)
  huggingFaceToken: string, Optional. Token used to access Hugging Face gated models.
  includeEquivalentModelGardenModelDeploymentConfigs: boolean, Optional. Whether to cnclude the deployment configs from the equivalent Model Garden model if the requested model is a Hugging Face model.
  isHuggingFaceModel: boolean, Optional. Boolean indicates whether the requested model is a Hugging Face model.
  languageCode: string, Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.
  view: string, Optional. PublisherModel view specifying which fields to read.
    Allowed values
      PUBLISHER_MODEL_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
      PUBLISHER_MODEL_VIEW_BASIC - Include basic metadata about the publisher model, but not the full contents.
      PUBLISHER_MODEL_VIEW_FULL - Include everything.
      PUBLISHER_MODEL_VERSION_VIEW_BASIC - Include: VersionId, ModelVersionExternalName, and SupportedActions.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Model Garden Publisher Model.
  "frameworks": [ # Optional. Additional information about the model's Frameworks.
    "A String",
  ],
  "launchStage": "A String", # Optional. Indicates the launch stage of the model.
  "name": "A String", # Output only. The resource name of the PublisherModel.
  "openSourceCategory": "A String", # Required. Indicates the open source category of the publisher model.
  "parent": { # The information about the parent of a model. # Optional. The parent that this model was customized from. E.g., Vision API, Natural Language API, LaMDA, T5, etc. Foundation models don't have parents.
    "displayName": "A String", # Required. The display name of the parent. E.g., LaMDA, T5, Vision API, Natural Language API.
    "reference": { # Reference to a resource. # Optional. The Google Cloud resource name or the URI reference.
      "description": "A String", # Description of the resource.
      "resourceName": "A String", # The resource name of the Google Cloud resource.
      "uri": "A String", # The URI of the resource.
      "useCase": "A String", # Use case (CUJ) of the resource.
    },
  },
  "predictSchemata": { # Contains the schemata used in Model's predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob. # Optional. The schemata that describes formats of the PublisherModel's predictions and explanations as given and returned via PredictionService.Predict.
    "instanceSchemaUri": "A String", # Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single instance, which are used in PredictRequest.instances, ExplainRequest.instances and BatchPredictionJob.input_config. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
    "parametersSchemaUri": "A String", # Immutable. Points to a YAML file stored on Google Cloud Storage describing the parameters of prediction and explanation via PredictRequest.parameters, ExplainRequest.parameters and BatchPredictionJob.model_parameters. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI, if no parameters are supported, then it is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
    "predictionSchemaUri": "A String", # Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single prediction produced by this Model, which are returned via PredictResponse.predictions, ExplainResponse.explanations, and BatchPredictionJob.output_config. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
  },
  "publisherModelTemplate": "A String", # Optional. Output only. Immutable. Used to indicate this model has a publisher model and provide the template of the publisher model resource name.
  "supportedActions": { # Actions could take on this Publisher Model. # Optional. Supported call-to-action options.
    "createApplication": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Create application using the PublisherModel.
      "colabNotebookDisabled": True or False, # Optional. For notebook resource. When set to true, the Colab Enterprise link will be disabled in the "open notebook" dialog in UI.
      "references": { # Required.
        "a_key": { # Reference to a resource.
          "description": "A String", # Description of the resource.
          "resourceName": "A String", # The resource name of the Google Cloud resource.
          "uri": "A String", # The URI of the resource.
          "useCase": "A String", # Use case (CUJ) of the resource.
        },
      },
      "resourceDescription": "A String", # Optional. Description of the resource.
      "resourceTitle": "A String", # Optional. Title of the resource.
      "resourceUseCase": "A String", # Optional. Use case (CUJ) of the resource.
      "supportsWorkbench": True or False, # Optional. For notebook resource, whether the notebook supports Workbench.
      "title": "A String", # Required.
    },
    "deploy": { # Model metadata that is needed for UploadModel or DeployModel/CreateEndpoint requests. # Optional. Deploy the PublisherModel to Vertex Endpoint.
      "artifactUri": "A String", # Optional. The path to the directory containing the Model artifact and any of its supporting files.
      "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.
        "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number.
        "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error.
      },
      "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Optional. The specification of the container that is to be used when deploying this Model in Vertex AI. Not present for Large Models.
        "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
          "A String",
        ],
        "command": [ # Immutable. Specifies the command that runs when the container starts. This overrides the container's [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint). Specify this field as an array of executable and arguments, similar to a Docker `ENTRYPOINT`'s "exec" form, not its "shell" form. If you do not specify this field, then the container's `ENTRYPOINT` runs, in conjunction with the args field or the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd), if either exists. If this field is not specified and the container does not have an `ENTRYPOINT`, then refer to the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). If you specify this field, then you can also specify the `args` field to provide additional arguments for this command. However, if you specify this field, then the container's `CMD` is ignored. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `command` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
          "A String",
        ],
        "deploymentTimeout": "A String", # Immutable. Deployment timeout. Limit for deployment timeout is 2 hours.
        "env": [ # Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables. Additionally, the command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable `VAR_2` to have the value `foo bar`: ```json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", "value": "$(VAR_1) bar" } ] ``` If you switch the order of the variables in the example, then the expansion does not occur. This field corresponds to the `env` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
          { # Represents an environment variable present in a Container or Python Module.
            "name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
            "value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
          },
        ],
        "grpcPorts": [ # Immutable. List of ports to expose from the container. Vertex AI sends gRPC prediction requests that it receives to the first port on this list. Vertex AI also sends liveness and health checks to this port. If you do not specify this field, gRPC requests to the container will be disabled. Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers v1 core API.
          { # Represents a network port in a container.
            "containerPort": 42, # The number of the port to expose on the pod's IP address. Must be a valid port number, between 1 and 65535 inclusive.
          },
        ],
        "healthProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes readiness probe.
          "exec": { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
            "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
              "A String",
            ],
          },
          "failureThreshold": 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.
          "grpc": { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
            "port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
            "service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
          },
          "httpGet": { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
            "host": "A String", # Host name to connect to, defaults to the model serving container's IP. You probably want to set "Host" in httpHeaders instead.
            "httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
              { # HttpHeader describes a custom header to be used in HTTP probes
                "name": "A String", # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
                "value": "A String", # The header field value
              },
            ],
            "path": "A String", # Path to access on the HTTP server.
            "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
            "scheme": "A String", # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
          },
          "initialDelaySeconds": 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.
          "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'.
          "successThreshold": 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'.
          "tcpSocket": { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
            "host": "A String", # Optional: Host name to connect to, defaults to the model serving container's IP.
            "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
          },
          "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'.
        },
        "healthRoute": "A String", # Immutable. HTTP path on the container to send health checks to. Vertex AI intermittently sends GET requests to this path on the container's IP address and port to check that the container is healthy. Read more about [health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#health). For example, if you set this field to `/bar`, then Vertex AI intermittently sends a GET request to the `/bar` path on the port of your container specified by the first value of this `ModelContainerSpec`'s ports field. If you don't specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/ DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
        "imageUri": "A String", # Required. Immutable. URI of the Docker image to be used as the custom container for serving predictions. This URI must identify an image in Artifact Registry or Container Registry. Learn more about the [container publishing requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing), including permissions requirements for the Vertex AI Service Agent. The container image is ingested upon ModelService.UploadModel, stored internally, and this original path is afterwards not used. To learn about the requirements for the Docker image itself, see [Custom container requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#). You can use the URI to one of Vertex AI's [pre-built container images for prediction](https://cloud.google.com/vertex-ai/docs/predictions/pre-built-containers) in this field.
        "invokeRoutePrefix": "A String", # Immutable. Invoke route prefix for the custom container. "/*" is the only supported value right now. By setting this field, any non-root route on this model will be accessible with invoke http call eg: "/invoke/foo/bar", however the [PredictionService.Invoke] RPC is not supported yet. Only one of `predict_route` or `invoke_route_prefix` can be set, and we default to using `predict_route` if this field is not set. If this field is set, the Model can only be deployed to dedicated endpoint.
        "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes liveness probe.
          "exec": { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
            "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
              "A String",
            ],
          },
          "failureThreshold": 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.
          "grpc": { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
            "port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
            "service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
          },
          "httpGet": { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
            "host": "A String", # Host name to connect to, defaults to the model serving container's IP. You probably want to set "Host" in httpHeaders instead.
            "httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
              { # HttpHeader describes a custom header to be used in HTTP probes
                "name": "A String", # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
                "value": "A String", # The header field value
              },
            ],
            "path": "A String", # Path to access on the HTTP server.
            "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
            "scheme": "A String", # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
          },
          "initialDelaySeconds": 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.
          "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'.
          "successThreshold": 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'.
          "tcpSocket": { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
            "host": "A String", # Optional: Host name to connect to, defaults to the model serving container's IP.
            "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
          },
          "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'.
        },
        "ports": [ # Immutable. List of ports to expose from the container. Vertex AI sends any prediction requests that it receives to the first port on this list. Vertex AI also sends [liveness and health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#liveness) to this port. If you do not specify this field, it defaults to following value: ```json [ { "containerPort": 8080 } ] ``` Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
          { # Represents a network port in a container.
            "containerPort": 42, # The number of the port to expose on the pod's IP address. Must be a valid port number, between 1 and 65535 inclusive.
          },
        ],
        "predictRoute": "A String", # Immutable. HTTP path on the container to send prediction requests to. Vertex AI forwards requests sent using projects.locations.endpoints.predict to this path on the container's IP address and port. Vertex AI then returns the container's response in the API response. For example, if you set this field to `/foo`, then when Vertex AI receives a prediction request, it forwards the request body in a POST request to the `/foo` path on the port of your container specified by the first value of this `ModelContainerSpec`'s ports field. If you don't specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
        "sharedMemorySizeMb": "A String", # Immutable. The amount of the VM memory to reserve as the shared memory for the model in megabytes.
        "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes startup probe.
          "exec": { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
            "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
              "A String",
            ],
          },
          "failureThreshold": 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.
          "grpc": { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
            "port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
            "service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
          },
          "httpGet": { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
            "host": "A String", # Host name to connect to, defaults to the model serving container's IP. You probably want to set "Host" in httpHeaders instead.
            "httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
              { # HttpHeader describes a custom header to be used in HTTP probes
                "name": "A String", # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
                "value": "A String", # The header field value
              },
            ],
            "path": "A String", # Path to access on the HTTP server.
            "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
            "scheme": "A String", # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
          },
          "initialDelaySeconds": 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.
          "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'.
          "successThreshold": 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'.
          "tcpSocket": { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
            "host": "A String", # Optional: Host name to connect to, defaults to the model serving container's IP.
            "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
          },
          "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'.
        },
      },
      "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration.
        "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`.
          { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count.
            "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count`
            "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info
              "a_key": "A String",
            },
            "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided.
          },
        ],
        "flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
          "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
        },
        "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
          "acceleratorCount": 42, # The number of accelerators to attach to the machine.
          "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
          "gpuPartitionSize": "A String", # Optional. Immutable. The Nvidia GPU partition size. When specified, the requested accelerators will be partitioned into smaller GPU partitions. For example, if the request is for 8 units of NVIDIA A100 GPUs, and gpu_partition_size="1g.10gb", the service will create 8 * 7 = 56 partitioned MIG instances. The partition size must be a value supported by the requested accelerator. Refer to [Nvidia GPU Partitioning](https://cloud.google.com/kubernetes-engine/docs/how-to/gpus-multi#multi-instance_gpu_partitions) for the available partition sizes. If set, the accelerator_count should be set to 1.
          "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
          "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments.
          "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
            "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
            "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
            "values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block.
              "A String",
            ],
          },
          "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
        },
        "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type).
        "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed.
        "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count.
        "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
      },
      "deployMetadata": { # Metadata information about the deployment for managing deployment config. # Optional. Metadata information about this deployment config.
        "labels": { # Optional. Labels for the deployment config. For managing deployment config like verifying, source of deployment config, etc.
          "a_key": "A String",
        },
        "sampleRequest": "A String", # Optional. Sample request for deployed endpoint.
      },
      "deployTaskName": "A String", # Optional. The name of the deploy task (e.g., "text to image generation").
      "largeModelReference": { # Contains information about the Large Model. # Optional. Large model reference. When this is set, model_artifact_spec is not needed.
        "name": "A String", # Required. The unique name of the large Foundation or pre-built model. Like "chat-bison", "text-bison". Or model name with version ID, like "chat-bison@001", "text-bison@005", etc.
      },
      "modelDisplayName": "A String", # Optional. Default model display name.
      "publicArtifactUri": "A String", # Optional. The signed URI for ephemeral Cloud Storage access to model artifact.
      "sharedResources": "A String", # The resource name of the shared DeploymentResourcePool to deploy on. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
      "title": "A String", # Required. The title of the regional resource reference.
    },
    "deployGke": { # Configurations for PublisherModel GKE deployment # Optional. Deploy PublisherModel to Google Kubernetes Engine.
      "gkeYamlConfigs": [ # Optional. GKE deployment configuration in yaml format.
        "A String",
      ],
    },
    "multiDeployVertex": { # Multiple setups to deploy the PublisherModel. # Optional. Multiple setups to deploy the PublisherModel to Vertex Endpoint.
      "multiDeployVertex": [ # Optional. One click deployment configurations.
        { # Model metadata that is needed for UploadModel or DeployModel/CreateEndpoint requests.
          "artifactUri": "A String", # Optional. The path to the directory containing the Model artifact and any of its supporting files.
          "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.
            "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number.
            "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error.
          },
          "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Optional. The specification of the container that is to be used when deploying this Model in Vertex AI. Not present for Large Models.
            "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
              "A String",
            ],
            "command": [ # Immutable. Specifies the command that runs when the container starts. This overrides the container's [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint). Specify this field as an array of executable and arguments, similar to a Docker `ENTRYPOINT`'s "exec" form, not its "shell" form. If you do not specify this field, then the container's `ENTRYPOINT` runs, in conjunction with the args field or the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd), if either exists. If this field is not specified and the container does not have an `ENTRYPOINT`, then refer to the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). If you specify this field, then you can also specify the `args` field to provide additional arguments for this command. However, if you specify this field, then the container's `CMD` is ignored. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `command` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
              "A String",
            ],
            "deploymentTimeout": "A String", # Immutable. Deployment timeout. Limit for deployment timeout is 2 hours.
            "env": [ # Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables. Additionally, the command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable `VAR_2` to have the value `foo bar`: ```json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", "value": "$(VAR_1) bar" } ] ``` If you switch the order of the variables in the example, then the expansion does not occur. This field corresponds to the `env` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
              { # Represents an environment variable present in a Container or Python Module.
                "name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
                "value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
              },
            ],
            "grpcPorts": [ # Immutable. List of ports to expose from the container. Vertex AI sends gRPC prediction requests that it receives to the first port on this list. Vertex AI also sends liveness and health checks to this port. If you do not specify this field, gRPC requests to the container will be disabled. Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers v1 core API.
              { # Represents a network port in a container.
                "containerPort": 42, # The number of the port to expose on the pod's IP address. Must be a valid port number, between 1 and 65535 inclusive.
              },
            ],
            "healthProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes readiness probe.
              "exec": { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
                "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
                  "A String",
                ],
              },
              "failureThreshold": 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.
              "grpc": { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
                "port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
                "service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
              },
              "httpGet": { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
                "host": "A String", # Host name to connect to, defaults to the model serving container's IP. You probably want to set "Host" in httpHeaders instead.
                "httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
                  { # HttpHeader describes a custom header to be used in HTTP probes
                    "name": "A String", # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
                    "value": "A String", # The header field value
                  },
                ],
                "path": "A String", # Path to access on the HTTP server.
                "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
                "scheme": "A String", # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
              },
              "initialDelaySeconds": 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.
              "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'.
              "successThreshold": 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'.
              "tcpSocket": { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
                "host": "A String", # Optional: Host name to connect to, defaults to the model serving container's IP.
                "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
              },
              "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'.
            },
            "healthRoute": "A String", # Immutable. HTTP path on the container to send health checks to. Vertex AI intermittently sends GET requests to this path on the container's IP address and port to check that the container is healthy. Read more about [health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#health). For example, if you set this field to `/bar`, then Vertex AI intermittently sends a GET request to the `/bar` path on the port of your container specified by the first value of this `ModelContainerSpec`'s ports field. If you don't specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/ DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
            "imageUri": "A String", # Required. Immutable. URI of the Docker image to be used as the custom container for serving predictions. This URI must identify an image in Artifact Registry or Container Registry. Learn more about the [container publishing requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing), including permissions requirements for the Vertex AI Service Agent. The container image is ingested upon ModelService.UploadModel, stored internally, and this original path is afterwards not used. To learn about the requirements for the Docker image itself, see [Custom container requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#). You can use the URI to one of Vertex AI's [pre-built container images for prediction](https://cloud.google.com/vertex-ai/docs/predictions/pre-built-containers) in this field.
            "invokeRoutePrefix": "A String", # Immutable. Invoke route prefix for the custom container. "/*" is the only supported value right now. By setting this field, any non-root route on this model will be accessible with invoke http call eg: "/invoke/foo/bar", however the [PredictionService.Invoke] RPC is not supported yet. Only one of `predict_route` or `invoke_route_prefix` can be set, and we default to using `predict_route` if this field is not set. If this field is set, the Model can only be deployed to dedicated endpoint.
            "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes liveness probe.
              "exec": { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
                "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
                  "A String",
                ],
              },
              "failureThreshold": 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.
              "grpc": { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
                "port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
                "service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
              },
              "httpGet": { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
                "host": "A String", # Host name to connect to, defaults to the model serving container's IP. You probably want to set "Host" in httpHeaders instead.
                "httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
                  { # HttpHeader describes a custom header to be used in HTTP probes
                    "name": "A String", # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
                    "value": "A String", # The header field value
                  },
                ],
                "path": "A String", # Path to access on the HTTP server.
                "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
                "scheme": "A String", # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
              },
              "initialDelaySeconds": 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.
              "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'.
              "successThreshold": 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'.
              "tcpSocket": { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
                "host": "A String", # Optional: Host name to connect to, defaults to the model serving container's IP.
                "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
              },
              "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'.
            },
            "ports": [ # Immutable. List of ports to expose from the container. Vertex AI sends any prediction requests that it receives to the first port on this list. Vertex AI also sends [liveness and health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#liveness) to this port. If you do not specify this field, it defaults to following value: ```json [ { "containerPort": 8080 } ] ``` Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
              { # Represents a network port in a container.
                "containerPort": 42, # The number of the port to expose on the pod's IP address. Must be a valid port number, between 1 and 65535 inclusive.
              },
            ],
            "predictRoute": "A String", # Immutable. HTTP path on the container to send prediction requests to. Vertex AI forwards requests sent using projects.locations.endpoints.predict to this path on the container's IP address and port. Vertex AI then returns the container's response in the API response. For example, if you set this field to `/foo`, then when Vertex AI receives a prediction request, it forwards the request body in a POST request to the `/foo` path on the port of your container specified by the first value of this `ModelContainerSpec`'s ports field. If you don't specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
            "sharedMemorySizeMb": "A String", # Immutable. The amount of the VM memory to reserve as the shared memory for the model in megabytes.
            "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes startup probe.
              "exec": { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
                "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
                  "A String",
                ],
              },
              "failureThreshold": 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.
              "grpc": { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
                "port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
                "service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
              },
              "httpGet": { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
                "host": "A String", # Host name to connect to, defaults to the model serving container's IP. You probably want to set "Host" in httpHeaders instead.
                "httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
                  { # HttpHeader describes a custom header to be used in HTTP probes
                    "name": "A String", # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
                    "value": "A String", # The header field value
                  },
                ],
                "path": "A String", # Path to access on the HTTP server.
                "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
                "scheme": "A String", # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
              },
              "initialDelaySeconds": 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.
              "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'.
              "successThreshold": 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'.
              "tcpSocket": { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
                "host": "A String", # Optional: Host name to connect to, defaults to the model serving container's IP.
                "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
              },
              "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'.
            },
          },
          "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration.
            "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`.
              { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count.
                "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count`
                "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info
                  "a_key": "A String",
                },
                "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided.
              },
            ],
            "flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
              "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
            },
            "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
              "acceleratorCount": 42, # The number of accelerators to attach to the machine.
              "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
              "gpuPartitionSize": "A String", # Optional. Immutable. The Nvidia GPU partition size. When specified, the requested accelerators will be partitioned into smaller GPU partitions. For example, if the request is for 8 units of NVIDIA A100 GPUs, and gpu_partition_size="1g.10gb", the service will create 8 * 7 = 56 partitioned MIG instances. The partition size must be a value supported by the requested accelerator. Refer to [Nvidia GPU Partitioning](https://cloud.google.com/kubernetes-engine/docs/how-to/gpus-multi#multi-instance_gpu_partitions) for the available partition sizes. If set, the accelerator_count should be set to 1.
              "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
              "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments.
              "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
                "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
                "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
                "values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block.
                  "A String",
                ],
              },
              "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
            },
            "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type).
            "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed.
            "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count.
            "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
          },
          "deployMetadata": { # Metadata information about the deployment for managing deployment config. # Optional. Metadata information about this deployment config.
            "labels": { # Optional. Labels for the deployment config. For managing deployment config like verifying, source of deployment config, etc.
              "a_key": "A String",
            },
            "sampleRequest": "A String", # Optional. Sample request for deployed endpoint.
          },
          "deployTaskName": "A String", # Optional. The name of the deploy task (e.g., "text to image generation").
          "largeModelReference": { # Contains information about the Large Model. # Optional. Large model reference. When this is set, model_artifact_spec is not needed.
            "name": "A String", # Required. The unique name of the large Foundation or pre-built model. Like "chat-bison", "text-bison". Or model name with version ID, like "chat-bison@001", "text-bison@005", etc.
          },
          "modelDisplayName": "A String", # Optional. Default model display name.
          "publicArtifactUri": "A String", # Optional. The signed URI for ephemeral Cloud Storage access to model artifact.
          "sharedResources": "A String", # The resource name of the shared DeploymentResourcePool to deploy on. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
          "title": "A String", # Required. The title of the regional resource reference.
        },
      ],
    },
    "openEvaluationPipeline": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Open evaluation pipeline of the PublisherModel.
      "colabNotebookDisabled": True or False, # Optional. For notebook resource. When set to true, the Colab Enterprise link will be disabled in the "open notebook" dialog in UI.
      "references": { # Required.
        "a_key": { # Reference to a resource.
          "description": "A String", # Description of the resource.
          "resourceName": "A String", # The resource name of the Google Cloud resource.
          "uri": "A String", # The URI of the resource.
          "useCase": "A String", # Use case (CUJ) of the resource.
        },
      },
      "resourceDescription": "A String", # Optional. Description of the resource.
      "resourceTitle": "A String", # Optional. Title of the resource.
      "resourceUseCase": "A String", # Optional. Use case (CUJ) of the resource.
      "supportsWorkbench": True or False, # Optional. For notebook resource, whether the notebook supports Workbench.
      "title": "A String", # Required.
    },
    "openFineTuningPipeline": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Open fine-tuning pipeline of the PublisherModel.
      "colabNotebookDisabled": True or False, # Optional. For notebook resource. When set to true, the Colab Enterprise link will be disabled in the "open notebook" dialog in UI.
      "references": { # Required.
        "a_key": { # Reference to a resource.
          "description": "A String", # Description of the resource.
          "resourceName": "A String", # The resource name of the Google Cloud resource.
          "uri": "A String", # The URI of the resource.
          "useCase": "A String", # Use case (CUJ) of the resource.
        },
      },
      "resourceDescription": "A String", # Optional. Description of the resource.
      "resourceTitle": "A String", # Optional. Title of the resource.
      "resourceUseCase": "A String", # Optional. Use case (CUJ) of the resource.
      "supportsWorkbench": True or False, # Optional. For notebook resource, whether the notebook supports Workbench.
      "title": "A String", # Required.
    },
    "openFineTuningPipelines": { # Open fine tuning pipelines. # Optional. Open fine-tuning pipelines of the PublisherModel.
      "fineTuningPipelines": [ # Required. Regional resource references to fine tuning pipelines.
        { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc..
          "colabNotebookDisabled": True or False, # Optional. For notebook resource. When set to true, the Colab Enterprise link will be disabled in the "open notebook" dialog in UI.
          "references": { # Required.
            "a_key": { # Reference to a resource.
              "description": "A String", # Description of the resource.
              "resourceName": "A String", # The resource name of the Google Cloud resource.
              "uri": "A String", # The URI of the resource.
              "useCase": "A String", # Use case (CUJ) of the resource.
            },
          },
          "resourceDescription": "A String", # Optional. Description of the resource.
          "resourceTitle": "A String", # Optional. Title of the resource.
          "resourceUseCase": "A String", # Optional. Use case (CUJ) of the resource.
          "supportsWorkbench": True or False, # Optional. For notebook resource, whether the notebook supports Workbench.
          "title": "A String", # Required.
        },
      ],
    },
    "openGenerationAiStudio": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Open in Generation AI Studio.
      "colabNotebookDisabled": True or False, # Optional. For notebook resource. When set to true, the Colab Enterprise link will be disabled in the "open notebook" dialog in UI.
      "references": { # Required.
        "a_key": { # Reference to a resource.
          "description": "A String", # Description of the resource.
          "resourceName": "A String", # The resource name of the Google Cloud resource.
          "uri": "A String", # The URI of the resource.
          "useCase": "A String", # Use case (CUJ) of the resource.
        },
      },
      "resourceDescription": "A String", # Optional. Description of the resource.
      "resourceTitle": "A String", # Optional. Title of the resource.
      "resourceUseCase": "A String", # Optional. Use case (CUJ) of the resource.
      "supportsWorkbench": True or False, # Optional. For notebook resource, whether the notebook supports Workbench.
      "title": "A String", # Required.
    },
    "openGenie": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Open Genie / Playground.
      "colabNotebookDisabled": True or False, # Optional. For notebook resource. When set to true, the Colab Enterprise link will be disabled in the "open notebook" dialog in UI.
      "references": { # Required.
        "a_key": { # Reference to a resource.
          "description": "A String", # Description of the resource.
          "resourceName": "A String", # The resource name of the Google Cloud resource.
          "uri": "A String", # The URI of the resource.
          "useCase": "A String", # Use case (CUJ) of the resource.
        },
      },
      "resourceDescription": "A String", # Optional. Description of the resource.
      "resourceTitle": "A String", # Optional. Title of the resource.
      "resourceUseCase": "A String", # Optional. Use case (CUJ) of the resource.
      "supportsWorkbench": True or False, # Optional. For notebook resource, whether the notebook supports Workbench.
      "title": "A String", # Required.
    },
    "openNotebook": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Open notebook of the PublisherModel.
      "colabNotebookDisabled": True or False, # Optional. For notebook resource. When set to true, the Colab Enterprise link will be disabled in the "open notebook" dialog in UI.
      "references": { # Required.
        "a_key": { # Reference to a resource.
          "description": "A String", # Description of the resource.
          "resourceName": "A String", # The resource name of the Google Cloud resource.
          "uri": "A String", # The URI of the resource.
          "useCase": "A String", # Use case (CUJ) of the resource.
        },
      },
      "resourceDescription": "A String", # Optional. Description of the resource.
      "resourceTitle": "A String", # Optional. Title of the resource.
      "resourceUseCase": "A String", # Optional. Use case (CUJ) of the resource.
      "supportsWorkbench": True or False, # Optional. For notebook resource, whether the notebook supports Workbench.
      "title": "A String", # Required.
    },
    "openNotebooks": { # Open notebooks. # Optional. Open notebooks of the PublisherModel.
      "notebooks": [ # Required. Regional resource references to notebooks.
        { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc..
          "colabNotebookDisabled": True or False, # Optional. For notebook resource. When set to true, the Colab Enterprise link will be disabled in the "open notebook" dialog in UI.
          "references": { # Required.
            "a_key": { # Reference to a resource.
              "description": "A String", # Description of the resource.
              "resourceName": "A String", # The resource name of the Google Cloud resource.
              "uri": "A String", # The URI of the resource.
              "useCase": "A String", # Use case (CUJ) of the resource.
            },
          },
          "resourceDescription": "A String", # Optional. Description of the resource.
          "resourceTitle": "A String", # Optional. Title of the resource.
          "resourceUseCase": "A String", # Optional. Use case (CUJ) of the resource.
          "supportsWorkbench": True or False, # Optional. For notebook resource, whether the notebook supports Workbench.
          "title": "A String", # Required.
        },
      ],
    },
    "openPromptTuningPipeline": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Open prompt-tuning pipeline of the PublisherModel.
      "colabNotebookDisabled": True or False, # Optional. For notebook resource. When set to true, the Colab Enterprise link will be disabled in the "open notebook" dialog in UI.
      "references": { # Required.
        "a_key": { # Reference to a resource.
          "description": "A String", # Description of the resource.
          "resourceName": "A String", # The resource name of the Google Cloud resource.
          "uri": "A String", # The URI of the resource.
          "useCase": "A String", # Use case (CUJ) of the resource.
        },
      },
      "resourceDescription": "A String", # Optional. Description of the resource.
      "resourceTitle": "A String", # Optional. Title of the resource.
      "resourceUseCase": "A String", # Optional. Use case (CUJ) of the resource.
      "supportsWorkbench": True or False, # Optional. For notebook resource, whether the notebook supports Workbench.
      "title": "A String", # Required.
    },
    "requestAccess": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Request for access.
      "colabNotebookDisabled": True or False, # Optional. For notebook resource. When set to true, the Colab Enterprise link will be disabled in the "open notebook" dialog in UI.
      "references": { # Required.
        "a_key": { # Reference to a resource.
          "description": "A String", # Description of the resource.
          "resourceName": "A String", # The resource name of the Google Cloud resource.
          "uri": "A String", # The URI of the resource.
          "useCase": "A String", # Use case (CUJ) of the resource.
        },
      },
      "resourceDescription": "A String", # Optional. Description of the resource.
      "resourceTitle": "A String", # Optional. Title of the resource.
      "resourceUseCase": "A String", # Optional. Use case (CUJ) of the resource.
      "supportsWorkbench": True or False, # Optional. For notebook resource, whether the notebook supports Workbench.
      "title": "A String", # Required.
    },
    "viewRestApi": { # Rest API docs. # Optional. To view Rest API docs.
      "documentations": [ # Required.
        { # A named piece of documentation.
          "content": "A String", # Required. Content of this piece of document (in Markdown format).
          "title": "A String", # Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, JAVA, NODE.JS, etc..
        },
      ],
      "title": "A String", # Required. The title of the view rest API.
    },
  },
  "versionId": "A String", # Output only. Immutable. The version ID of the PublisherModel. A new version is committed when a new model version is uploaded under an existing model id. It is an auto-incrementing decimal number in string representation.
  "versionState": "A String", # Optional. Indicates the state of the model version.
}

list(parent, filter=None, languageCode=None, listAllVersions=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)

Lists publisher models in Model Garden.

Args:
  parent: string, Required. The name of the Publisher from which to list the PublisherModels. Format: `publishers/{publisher}` (required)
  filter: string, Optional. The standard list filter.
  languageCode: string, Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in. If not set, by default English (en).
  listAllVersions: boolean, Optional. List all publisher model versions if the flag is set to true.
  orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
  pageSize: integer, Optional. The standard list page size.
  pageToken: string, Optional. The standard list page token. Typically obtained via ListPublisherModelsResponse.next_page_token of the previous ModelGardenService.ListPublisherModels call.
  view: string, Optional. PublisherModel view specifying which fields to read.
    Allowed values
      PUBLISHER_MODEL_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
      PUBLISHER_MODEL_VIEW_BASIC - Include basic metadata about the publisher model, but not the full contents.
      PUBLISHER_MODEL_VIEW_FULL - Include everything.
      PUBLISHER_MODEL_VERSION_VIEW_BASIC - Include: VersionId, ModelVersionExternalName, and SupportedActions.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for ModelGardenService.ListPublisherModels.
  "nextPageToken": "A String", # A token to retrieve next page of results. Pass to ListPublisherModels.page_token to obtain that page.
  "publisherModels": [ # List of PublisherModels in the requested page.
    { # A Model Garden Publisher Model.
      "frameworks": [ # Optional. Additional information about the model's Frameworks.
        "A String",
      ],
      "launchStage": "A String", # Optional. Indicates the launch stage of the model.
      "name": "A String", # Output only. The resource name of the PublisherModel.
      "openSourceCategory": "A String", # Required. Indicates the open source category of the publisher model.
      "parent": { # The information about the parent of a model. # Optional. The parent that this model was customized from. E.g., Vision API, Natural Language API, LaMDA, T5, etc. Foundation models don't have parents.
        "displayName": "A String", # Required. The display name of the parent. E.g., LaMDA, T5, Vision API, Natural Language API.
        "reference": { # Reference to a resource. # Optional. The Google Cloud resource name or the URI reference.
          "description": "A String", # Description of the resource.
          "resourceName": "A String", # The resource name of the Google Cloud resource.
          "uri": "A String", # The URI of the resource.
          "useCase": "A String", # Use case (CUJ) of the resource.
        },
      },
      "predictSchemata": { # Contains the schemata used in Model's predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob. # Optional. The schemata that describes formats of the PublisherModel's predictions and explanations as given and returned via PredictionService.Predict.
        "instanceSchemaUri": "A String", # Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single instance, which are used in PredictRequest.instances, ExplainRequest.instances and BatchPredictionJob.input_config. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
        "parametersSchemaUri": "A String", # Immutable. Points to a YAML file stored on Google Cloud Storage describing the parameters of prediction and explanation via PredictRequest.parameters, ExplainRequest.parameters and BatchPredictionJob.model_parameters. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI, if no parameters are supported, then it is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
        "predictionSchemaUri": "A String", # Immutable. Points to a YAML file stored on Google Cloud Storage describing the format of a single prediction produced by this Model, which are returned via PredictResponse.predictions, ExplainResponse.explanations, and BatchPredictionJob.output_config. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
      },
      "publisherModelTemplate": "A String", # Optional. Output only. Immutable. Used to indicate this model has a publisher model and provide the template of the publisher model resource name.
      "supportedActions": { # Actions could take on this Publisher Model. # Optional. Supported call-to-action options.
        "createApplication": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Create application using the PublisherModel.
          "colabNotebookDisabled": True or False, # Optional. For notebook resource. When set to true, the Colab Enterprise link will be disabled in the "open notebook" dialog in UI.
          "references": { # Required.
            "a_key": { # Reference to a resource.
              "description": "A String", # Description of the resource.
              "resourceName": "A String", # The resource name of the Google Cloud resource.
              "uri": "A String", # The URI of the resource.
              "useCase": "A String", # Use case (CUJ) of the resource.
            },
          },
          "resourceDescription": "A String", # Optional. Description of the resource.
          "resourceTitle": "A String", # Optional. Title of the resource.
          "resourceUseCase": "A String", # Optional. Use case (CUJ) of the resource.
          "supportsWorkbench": True or False, # Optional. For notebook resource, whether the notebook supports Workbench.
          "title": "A String", # Required.
        },
        "deploy": { # Model metadata that is needed for UploadModel or DeployModel/CreateEndpoint requests. # Optional. Deploy the PublisherModel to Vertex Endpoint.
          "artifactUri": "A String", # Optional. The path to the directory containing the Model artifact and any of its supporting files.
          "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.
            "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number.
            "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error.
          },
          "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Optional. The specification of the container that is to be used when deploying this Model in Vertex AI. Not present for Large Models.
            "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
              "A String",
            ],
            "command": [ # Immutable. Specifies the command that runs when the container starts. This overrides the container's [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint). Specify this field as an array of executable and arguments, similar to a Docker `ENTRYPOINT`'s "exec" form, not its "shell" form. If you do not specify this field, then the container's `ENTRYPOINT` runs, in conjunction with the args field or the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd), if either exists. If this field is not specified and the container does not have an `ENTRYPOINT`, then refer to the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). If you specify this field, then you can also specify the `args` field to provide additional arguments for this command. However, if you specify this field, then the container's `CMD` is ignored. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `command` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
              "A String",
            ],
            "deploymentTimeout": "A String", # Immutable. Deployment timeout. Limit for deployment timeout is 2 hours.
            "env": [ # Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables. Additionally, the command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable `VAR_2` to have the value `foo bar`: ```json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", "value": "$(VAR_1) bar" } ] ``` If you switch the order of the variables in the example, then the expansion does not occur. This field corresponds to the `env` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
              { # Represents an environment variable present in a Container or Python Module.
                "name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
                "value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
              },
            ],
            "grpcPorts": [ # Immutable. List of ports to expose from the container. Vertex AI sends gRPC prediction requests that it receives to the first port on this list. Vertex AI also sends liveness and health checks to this port. If you do not specify this field, gRPC requests to the container will be disabled. Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers v1 core API.
              { # Represents a network port in a container.
                "containerPort": 42, # The number of the port to expose on the pod's IP address. Must be a valid port number, between 1 and 65535 inclusive.
              },
            ],
            "healthProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes readiness probe.
              "exec": { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
                "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
                  "A String",
                ],
              },
              "failureThreshold": 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.
              "grpc": { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
                "port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
                "service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
              },
              "httpGet": { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
                "host": "A String", # Host name to connect to, defaults to the model serving container's IP. You probably want to set "Host" in httpHeaders instead.
                "httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
                  { # HttpHeader describes a custom header to be used in HTTP probes
                    "name": "A String", # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
                    "value": "A String", # The header field value
                  },
                ],
                "path": "A String", # Path to access on the HTTP server.
                "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
                "scheme": "A String", # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
              },
              "initialDelaySeconds": 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.
              "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'.
              "successThreshold": 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'.
              "tcpSocket": { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
                "host": "A String", # Optional: Host name to connect to, defaults to the model serving container's IP.
                "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
              },
              "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'.
            },
            "healthRoute": "A String", # Immutable. HTTP path on the container to send health checks to. Vertex AI intermittently sends GET requests to this path on the container's IP address and port to check that the container is healthy. Read more about [health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#health). For example, if you set this field to `/bar`, then Vertex AI intermittently sends a GET request to the `/bar` path on the port of your container specified by the first value of this `ModelContainerSpec`'s ports field. If you don't specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/ DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
            "imageUri": "A String", # Required. Immutable. URI of the Docker image to be used as the custom container for serving predictions. This URI must identify an image in Artifact Registry or Container Registry. Learn more about the [container publishing requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing), including permissions requirements for the Vertex AI Service Agent. The container image is ingested upon ModelService.UploadModel, stored internally, and this original path is afterwards not used. To learn about the requirements for the Docker image itself, see [Custom container requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#). You can use the URI to one of Vertex AI's [pre-built container images for prediction](https://cloud.google.com/vertex-ai/docs/predictions/pre-built-containers) in this field.
            "invokeRoutePrefix": "A String", # Immutable. Invoke route prefix for the custom container. "/*" is the only supported value right now. By setting this field, any non-root route on this model will be accessible with invoke http call eg: "/invoke/foo/bar", however the [PredictionService.Invoke] RPC is not supported yet. Only one of `predict_route` or `invoke_route_prefix` can be set, and we default to using `predict_route` if this field is not set. If this field is set, the Model can only be deployed to dedicated endpoint.
            "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes liveness probe.
              "exec": { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
                "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
                  "A String",
                ],
              },
              "failureThreshold": 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.
              "grpc": { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
                "port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
                "service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
              },
              "httpGet": { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
                "host": "A String", # Host name to connect to, defaults to the model serving container's IP. You probably want to set "Host" in httpHeaders instead.
                "httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
                  { # HttpHeader describes a custom header to be used in HTTP probes
                    "name": "A String", # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
                    "value": "A String", # The header field value
                  },
                ],
                "path": "A String", # Path to access on the HTTP server.
                "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
                "scheme": "A String", # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
              },
              "initialDelaySeconds": 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.
              "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'.
              "successThreshold": 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'.
              "tcpSocket": { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
                "host": "A String", # Optional: Host name to connect to, defaults to the model serving container's IP.
                "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
              },
              "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'.
            },
            "ports": [ # Immutable. List of ports to expose from the container. Vertex AI sends any prediction requests that it receives to the first port on this list. Vertex AI also sends [liveness and health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#liveness) to this port. If you do not specify this field, it defaults to following value: ```json [ { "containerPort": 8080 } ] ``` Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
              { # Represents a network port in a container.
                "containerPort": 42, # The number of the port to expose on the pod's IP address. Must be a valid port number, between 1 and 65535 inclusive.
              },
            ],
            "predictRoute": "A String", # Immutable. HTTP path on the container to send prediction requests to. Vertex AI forwards requests sent using projects.locations.endpoints.predict to this path on the container's IP address and port. Vertex AI then returns the container's response in the API response. For example, if you set this field to `/foo`, then when Vertex AI receives a prediction request, it forwards the request body in a POST request to the `/foo` path on the port of your container specified by the first value of this `ModelContainerSpec`'s ports field. If you don't specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
            "sharedMemorySizeMb": "A String", # Immutable. The amount of the VM memory to reserve as the shared memory for the model in megabytes.
            "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes startup probe.
              "exec": { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
                "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
                  "A String",
                ],
              },
              "failureThreshold": 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.
              "grpc": { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
                "port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
                "service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
              },
              "httpGet": { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
                "host": "A String", # Host name to connect to, defaults to the model serving container's IP. You probably want to set "Host" in httpHeaders instead.
                "httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
                  { # HttpHeader describes a custom header to be used in HTTP probes
                    "name": "A String", # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
                    "value": "A String", # The header field value
                  },
                ],
                "path": "A String", # Path to access on the HTTP server.
                "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
                "scheme": "A String", # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
              },
              "initialDelaySeconds": 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.
              "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'.
              "successThreshold": 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'.
              "tcpSocket": { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
                "host": "A String", # Optional: Host name to connect to, defaults to the model serving container's IP.
                "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
              },
              "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'.
            },
          },
          "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration.
            "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`.
              { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count.
                "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count`
                "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info
                  "a_key": "A String",
                },
                "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided.
              },
            ],
            "flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
              "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
            },
            "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
              "acceleratorCount": 42, # The number of accelerators to attach to the machine.
              "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
              "gpuPartitionSize": "A String", # Optional. Immutable. The Nvidia GPU partition size. When specified, the requested accelerators will be partitioned into smaller GPU partitions. For example, if the request is for 8 units of NVIDIA A100 GPUs, and gpu_partition_size="1g.10gb", the service will create 8 * 7 = 56 partitioned MIG instances. The partition size must be a value supported by the requested accelerator. Refer to [Nvidia GPU Partitioning](https://cloud.google.com/kubernetes-engine/docs/how-to/gpus-multi#multi-instance_gpu_partitions) for the available partition sizes. If set, the accelerator_count should be set to 1.
              "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
              "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments.
              "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
                "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
                "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
                "values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block.
                  "A String",
                ],
              },
              "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
            },
            "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type).
            "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed.
            "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count.
            "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
          },
          "deployMetadata": { # Metadata information about the deployment for managing deployment config. # Optional. Metadata information about this deployment config.
            "labels": { # Optional. Labels for the deployment config. For managing deployment config like verifying, source of deployment config, etc.
              "a_key": "A String",
            },
            "sampleRequest": "A String", # Optional. Sample request for deployed endpoint.
          },
          "deployTaskName": "A String", # Optional. The name of the deploy task (e.g., "text to image generation").
          "largeModelReference": { # Contains information about the Large Model. # Optional. Large model reference. When this is set, model_artifact_spec is not needed.
            "name": "A String", # Required. The unique name of the large Foundation or pre-built model. Like "chat-bison", "text-bison". Or model name with version ID, like "chat-bison@001", "text-bison@005", etc.
          },
          "modelDisplayName": "A String", # Optional. Default model display name.
          "publicArtifactUri": "A String", # Optional. The signed URI for ephemeral Cloud Storage access to model artifact.
          "sharedResources": "A String", # The resource name of the shared DeploymentResourcePool to deploy on. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
          "title": "A String", # Required. The title of the regional resource reference.
        },
        "deployGke": { # Configurations for PublisherModel GKE deployment # Optional. Deploy PublisherModel to Google Kubernetes Engine.
          "gkeYamlConfigs": [ # Optional. GKE deployment configuration in yaml format.
            "A String",
          ],
        },
        "multiDeployVertex": { # Multiple setups to deploy the PublisherModel. # Optional. Multiple setups to deploy the PublisherModel to Vertex Endpoint.
          "multiDeployVertex": [ # Optional. One click deployment configurations.
            { # Model metadata that is needed for UploadModel or DeployModel/CreateEndpoint requests.
              "artifactUri": "A String", # Optional. The path to the directory containing the Model artifact and any of its supporting files.
              "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.
                "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number.
                "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error.
              },
              "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Optional. The specification of the container that is to be used when deploying this Model in Vertex AI. Not present for Large Models.
                "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
                  "A String",
                ],
                "command": [ # Immutable. Specifies the command that runs when the container starts. This overrides the container's [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint). Specify this field as an array of executable and arguments, similar to a Docker `ENTRYPOINT`'s "exec" form, not its "shell" form. If you do not specify this field, then the container's `ENTRYPOINT` runs, in conjunction with the args field or the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd), if either exists. If this field is not specified and the container does not have an `ENTRYPOINT`, then refer to the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). If you specify this field, then you can also specify the `args` field to provide additional arguments for this command. However, if you specify this field, then the container's `CMD` is ignored. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `command` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
                  "A String",
                ],
                "deploymentTimeout": "A String", # Immutable. Deployment timeout. Limit for deployment timeout is 2 hours.
                "env": [ # Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables. Additionally, the command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable `VAR_2` to have the value `foo bar`: ```json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", "value": "$(VAR_1) bar" } ] ``` If you switch the order of the variables in the example, then the expansion does not occur. This field corresponds to the `env` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
                  { # Represents an environment variable present in a Container or Python Module.
                    "name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
                    "value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
                  },
                ],
                "grpcPorts": [ # Immutable. List of ports to expose from the container. Vertex AI sends gRPC prediction requests that it receives to the first port on this list. Vertex AI also sends liveness and health checks to this port. If you do not specify this field, gRPC requests to the container will be disabled. Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers v1 core API.
                  { # Represents a network port in a container.
                    "containerPort": 42, # The number of the port to expose on the pod's IP address. Must be a valid port number, between 1 and 65535 inclusive.
                  },
                ],
                "healthProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes readiness probe.
                  "exec": { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
                    "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
                      "A String",
                    ],
                  },
                  "failureThreshold": 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.
                  "grpc": { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
                    "port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
                    "service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
                  },
                  "httpGet": { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
                    "host": "A String", # Host name to connect to, defaults to the model serving container's IP. You probably want to set "Host" in httpHeaders instead.
                    "httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
                      { # HttpHeader describes a custom header to be used in HTTP probes
                        "name": "A String", # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
                        "value": "A String", # The header field value
                      },
                    ],
                    "path": "A String", # Path to access on the HTTP server.
                    "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
                    "scheme": "A String", # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
                  },
                  "initialDelaySeconds": 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.
                  "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'.
                  "successThreshold": 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'.
                  "tcpSocket": { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
                    "host": "A String", # Optional: Host name to connect to, defaults to the model serving container's IP.
                    "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
                  },
                  "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'.
                },
                "healthRoute": "A String", # Immutable. HTTP path on the container to send health checks to. Vertex AI intermittently sends GET requests to this path on the container's IP address and port to check that the container is healthy. Read more about [health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#health). For example, if you set this field to `/bar`, then Vertex AI intermittently sends a GET request to the `/bar` path on the port of your container specified by the first value of this `ModelContainerSpec`'s ports field. If you don't specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/ DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
                "imageUri": "A String", # Required. Immutable. URI of the Docker image to be used as the custom container for serving predictions. This URI must identify an image in Artifact Registry or Container Registry. Learn more about the [container publishing requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing), including permissions requirements for the Vertex AI Service Agent. The container image is ingested upon ModelService.UploadModel, stored internally, and this original path is afterwards not used. To learn about the requirements for the Docker image itself, see [Custom container requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#). You can use the URI to one of Vertex AI's [pre-built container images for prediction](https://cloud.google.com/vertex-ai/docs/predictions/pre-built-containers) in this field.
                "invokeRoutePrefix": "A String", # Immutable. Invoke route prefix for the custom container. "/*" is the only supported value right now. By setting this field, any non-root route on this model will be accessible with invoke http call eg: "/invoke/foo/bar", however the [PredictionService.Invoke] RPC is not supported yet. Only one of `predict_route` or `invoke_route_prefix` can be set, and we default to using `predict_route` if this field is not set. If this field is set, the Model can only be deployed to dedicated endpoint.
                "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes liveness probe.
                  "exec": { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
                    "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
                      "A String",
                    ],
                  },
                  "failureThreshold": 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.
                  "grpc": { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
                    "port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
                    "service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
                  },
                  "httpGet": { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
                    "host": "A String", # Host name to connect to, defaults to the model serving container's IP. You probably want to set "Host" in httpHeaders instead.
                    "httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
                      { # HttpHeader describes a custom header to be used in HTTP probes
                        "name": "A String", # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
                        "value": "A String", # The header field value
                      },
                    ],
                    "path": "A String", # Path to access on the HTTP server.
                    "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
                    "scheme": "A String", # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
                  },
                  "initialDelaySeconds": 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.
                  "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'.
                  "successThreshold": 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'.
                  "tcpSocket": { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
                    "host": "A String", # Optional: Host name to connect to, defaults to the model serving container's IP.
                    "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
                  },
                  "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'.
                },
                "ports": [ # Immutable. List of ports to expose from the container. Vertex AI sends any prediction requests that it receives to the first port on this list. Vertex AI also sends [liveness and health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#liveness) to this port. If you do not specify this field, it defaults to following value: ```json [ { "containerPort": 8080 } ] ``` Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core).
                  { # Represents a network port in a container.
                    "containerPort": 42, # The number of the port to expose on the pod's IP address. Must be a valid port number, between 1 and 65535 inclusive.
                  },
                ],
                "predictRoute": "A String", # Immutable. HTTP path on the container to send prediction requests to. Vertex AI forwards requests sent using projects.locations.endpoints.predict to this path on the container's IP address and port. Vertex AI then returns the container's response in the API response. For example, if you set this field to `/foo`, then when Vertex AI receives a prediction request, it forwards the request body in a POST request to the `/foo` path on the port of your container specified by the first value of this `ModelContainerSpec`'s ports field. If you don't specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).)
                "sharedMemorySizeMb": "A String", # Immutable. The amount of the VM memory to reserve as the shared memory for the model in megabytes.
                "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes startup probe.
                  "exec": { # ExecAction specifies a command to execute. # ExecAction probes the health of a container by executing a command.
                    "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
                      "A String",
                    ],
                  },
                  "failureThreshold": 42, # Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.
                  "grpc": { # GrpcAction checks the health of a container using a gRPC service. # GrpcAction probes the health of a container by sending a gRPC request.
                    "port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
                    "service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest. See https://github.com/grpc/grpc/blob/master/doc/health-checking.md. If this is not specified, the default behavior is defined by gRPC.
                  },
                  "httpGet": { # HttpGetAction describes an action based on HTTP Get requests. # HttpGetAction probes the health of a container by sending an HTTP GET request.
                    "host": "A String", # Host name to connect to, defaults to the model serving container's IP. You probably want to set "Host" in httpHeaders instead.
                    "httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
                      { # HttpHeader describes a custom header to be used in HTTP probes
                        "name": "A String", # The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
                        "value": "A String", # The header field value
                      },
                    ],
                    "path": "A String", # Path to access on the HTTP server.
                    "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
                    "scheme": "A String", # Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
                  },
                  "initialDelaySeconds": 42, # Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.
                  "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'.
                  "successThreshold": 42, # Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'.
                  "tcpSocket": { # TcpSocketAction probes the health of a container by opening a TCP socket connection. # TcpSocketAction probes the health of a container by opening a TCP socket connection.
                    "host": "A String", # Optional: Host name to connect to, defaults to the model serving container's IP.
                    "port": 42, # Number of the port to access on the container. Number must be in the range 1 to 65535.
                  },
                  "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'.
                },
              },
              "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration.
                "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`.
                  { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count.
                    "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` * `aiplatform.googleapis.com/prediction/online/request_count`
                    "monitoredResourceLabels": { # Optional. The Cloud Monitoring monitored resource labels as key value pairs used for metrics filtering. See Cloud Monitoring Labels https://cloud.google.com/monitoring/api/v3/metric-model#generic-label-info
                      "a_key": "A String",
                    },
                    "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided.
                  },
                ],
                "flexStart": { # FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment. # Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)
                  "maxRuntimeDuration": "A String", # The max duration of the deployment is max_runtime_duration. The deployment will be terminated after the duration. The max_runtime_duration can be set up to 7 days.
                },
                "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine being used.
                  "acceleratorCount": 42, # The number of accelerators to attach to the machine.
                  "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
                  "gpuPartitionSize": "A String", # Optional. Immutable. The Nvidia GPU partition size. When specified, the requested accelerators will be partitioned into smaller GPU partitions. For example, if the request is for 8 units of NVIDIA A100 GPUs, and gpu_partition_size="1g.10gb", the service will create 8 * 7 = 56 partitioned MIG instances. The partition size must be a value supported by the requested accelerator. Refer to [Nvidia GPU Partitioning](https://cloud.google.com/kubernetes-engine/docs/how-to/gpus-multi#multi-instance_gpu_partitions) for the available partition sizes. If set, the accelerator_count should be set to 1.
                  "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
                  "multihostGpuNodeCount": 42, # Optional. Immutable. The number of nodes per replica for multihost GPU deployments.
                  "reservationAffinity": { # A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. # Optional. Immutable. Configuration controlling how this resource pool consumes reservation.
                    "key": "A String", # Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.
                    "reservationAffinityType": "A String", # Required. Specifies the reservation affinity type.
                    "values": [ # Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block.
                      "A String",
                    ],
                  },
                  "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
                },
                "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type).
                "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed.
                "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count.
                "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).
              },
              "deployMetadata": { # Metadata information about the deployment for managing deployment config. # Optional. Metadata information about this deployment config.
                "labels": { # Optional. Labels for the deployment config. For managing deployment config like verifying, source of deployment config, etc.
                  "a_key": "A String",
                },
                "sampleRequest": "A String", # Optional. Sample request for deployed endpoint.
              },
              "deployTaskName": "A String", # Optional. The name of the deploy task (e.g., "text to image generation").
              "largeModelReference": { # Contains information about the Large Model. # Optional. Large model reference. When this is set, model_artifact_spec is not needed.
                "name": "A String", # Required. The unique name of the large Foundation or pre-built model. Like "chat-bison", "text-bison". Or model name with version ID, like "chat-bison@001", "text-bison@005", etc.
              },
              "modelDisplayName": "A String", # Optional. Default model display name.
              "publicArtifactUri": "A String", # Optional. The signed URI for ephemeral Cloud Storage access to model artifact.
              "sharedResources": "A String", # The resource name of the shared DeploymentResourcePool to deploy on. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
              "title": "A String", # Required. The title of the regional resource reference.
            },
          ],
        },
        "openEvaluationPipeline": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Open evaluation pipeline of the PublisherModel.
          "colabNotebookDisabled": True or False, # Optional. For notebook resource. When set to true, the Colab Enterprise link will be disabled in the "open notebook" dialog in UI.
          "references": { # Required.
            "a_key": { # Reference to a resource.
              "description": "A String", # Description of the resource.
              "resourceName": "A String", # The resource name of the Google Cloud resource.
              "uri": "A String", # The URI of the resource.
              "useCase": "A String", # Use case (CUJ) of the resource.
            },
          },
          "resourceDescription": "A String", # Optional. Description of the resource.
          "resourceTitle": "A String", # Optional. Title of the resource.
          "resourceUseCase": "A String", # Optional. Use case (CUJ) of the resource.
          "supportsWorkbench": True or False, # Optional. For notebook resource, whether the notebook supports Workbench.
          "title": "A String", # Required.
        },
        "openFineTuningPipeline": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Open fine-tuning pipeline of the PublisherModel.
          "colabNotebookDisabled": True or False, # Optional. For notebook resource. When set to true, the Colab Enterprise link will be disabled in the "open notebook" dialog in UI.
          "references": { # Required.
            "a_key": { # Reference to a resource.
              "description": "A String", # Description of the resource.
              "resourceName": "A String", # The resource name of the Google Cloud resource.
              "uri": "A String", # The URI of the resource.
              "useCase": "A String", # Use case (CUJ) of the resource.
            },
          },
          "resourceDescription": "A String", # Optional. Description of the resource.
          "resourceTitle": "A String", # Optional. Title of the resource.
          "resourceUseCase": "A String", # Optional. Use case (CUJ) of the resource.
          "supportsWorkbench": True or False, # Optional. For notebook resource, whether the notebook supports Workbench.
          "title": "A String", # Required.
        },
        "openFineTuningPipelines": { # Open fine tuning pipelines. # Optional. Open fine-tuning pipelines of the PublisherModel.
          "fineTuningPipelines": [ # Required. Regional resource references to fine tuning pipelines.
            { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc..
              "colabNotebookDisabled": True or False, # Optional. For notebook resource. When set to true, the Colab Enterprise link will be disabled in the "open notebook" dialog in UI.
              "references": { # Required.
                "a_key": { # Reference to a resource.
                  "description": "A String", # Description of the resource.
                  "resourceName": "A String", # The resource name of the Google Cloud resource.
                  "uri": "A String", # The URI of the resource.
                  "useCase": "A String", # Use case (CUJ) of the resource.
                },
              },
              "resourceDescription": "A String", # Optional. Description of the resource.
              "resourceTitle": "A String", # Optional. Title of the resource.
              "resourceUseCase": "A String", # Optional. Use case (CUJ) of the resource.
              "supportsWorkbench": True or False, # Optional. For notebook resource, whether the notebook supports Workbench.
              "title": "A String", # Required.
            },
          ],
        },
        "openGenerationAiStudio": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Open in Generation AI Studio.
          "colabNotebookDisabled": True or False, # Optional. For notebook resource. When set to true, the Colab Enterprise link will be disabled in the "open notebook" dialog in UI.
          "references": { # Required.
            "a_key": { # Reference to a resource.
              "description": "A String", # Description of the resource.
              "resourceName": "A String", # The resource name of the Google Cloud resource.
              "uri": "A String", # The URI of the resource.
              "useCase": "A String", # Use case (CUJ) of the resource.
            },
          },
          "resourceDescription": "A String", # Optional. Description of the resource.
          "resourceTitle": "A String", # Optional. Title of the resource.
          "resourceUseCase": "A String", # Optional. Use case (CUJ) of the resource.
          "supportsWorkbench": True or False, # Optional. For notebook resource, whether the notebook supports Workbench.
          "title": "A String", # Required.
        },
        "openGenie": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Open Genie / Playground.
          "colabNotebookDisabled": True or False, # Optional. For notebook resource. When set to true, the Colab Enterprise link will be disabled in the "open notebook" dialog in UI.
          "references": { # Required.
            "a_key": { # Reference to a resource.
              "description": "A String", # Description of the resource.
              "resourceName": "A String", # The resource name of the Google Cloud resource.
              "uri": "A String", # The URI of the resource.
              "useCase": "A String", # Use case (CUJ) of the resource.
            },
          },
          "resourceDescription": "A String", # Optional. Description of the resource.
          "resourceTitle": "A String", # Optional. Title of the resource.
          "resourceUseCase": "A String", # Optional. Use case (CUJ) of the resource.
          "supportsWorkbench": True or False, # Optional. For notebook resource, whether the notebook supports Workbench.
          "title": "A String", # Required.
        },
        "openNotebook": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Open notebook of the PublisherModel.
          "colabNotebookDisabled": True or False, # Optional. For notebook resource. When set to true, the Colab Enterprise link will be disabled in the "open notebook" dialog in UI.
          "references": { # Required.
            "a_key": { # Reference to a resource.
              "description": "A String", # Description of the resource.
              "resourceName": "A String", # The resource name of the Google Cloud resource.
              "uri": "A String", # The URI of the resource.
              "useCase": "A String", # Use case (CUJ) of the resource.
            },
          },
          "resourceDescription": "A String", # Optional. Description of the resource.
          "resourceTitle": "A String", # Optional. Title of the resource.
          "resourceUseCase": "A String", # Optional. Use case (CUJ) of the resource.
          "supportsWorkbench": True or False, # Optional. For notebook resource, whether the notebook supports Workbench.
          "title": "A String", # Required.
        },
        "openNotebooks": { # Open notebooks. # Optional. Open notebooks of the PublisherModel.
          "notebooks": [ # Required. Regional resource references to notebooks.
            { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc..
              "colabNotebookDisabled": True or False, # Optional. For notebook resource. When set to true, the Colab Enterprise link will be disabled in the "open notebook" dialog in UI.
              "references": { # Required.
                "a_key": { # Reference to a resource.
                  "description": "A String", # Description of the resource.
                  "resourceName": "A String", # The resource name of the Google Cloud resource.
                  "uri": "A String", # The URI of the resource.
                  "useCase": "A String", # Use case (CUJ) of the resource.
                },
              },
              "resourceDescription": "A String", # Optional. Description of the resource.
              "resourceTitle": "A String", # Optional. Title of the resource.
              "resourceUseCase": "A String", # Optional. Use case (CUJ) of the resource.
              "supportsWorkbench": True or False, # Optional. For notebook resource, whether the notebook supports Workbench.
              "title": "A String", # Required.
            },
          ],
        },
        "openPromptTuningPipeline": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Open prompt-tuning pipeline of the PublisherModel.
          "colabNotebookDisabled": True or False, # Optional. For notebook resource. When set to true, the Colab Enterprise link will be disabled in the "open notebook" dialog in UI.
          "references": { # Required.
            "a_key": { # Reference to a resource.
              "description": "A String", # Description of the resource.
              "resourceName": "A String", # The resource name of the Google Cloud resource.
              "uri": "A String", # The URI of the resource.
              "useCase": "A String", # Use case (CUJ) of the resource.
            },
          },
          "resourceDescription": "A String", # Optional. Description of the resource.
          "resourceTitle": "A String", # Optional. Title of the resource.
          "resourceUseCase": "A String", # Optional. Use case (CUJ) of the resource.
          "supportsWorkbench": True or False, # Optional. For notebook resource, whether the notebook supports Workbench.
          "title": "A String", # Required.
        },
        "requestAccess": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Request for access.
          "colabNotebookDisabled": True or False, # Optional. For notebook resource. When set to true, the Colab Enterprise link will be disabled in the "open notebook" dialog in UI.
          "references": { # Required.
            "a_key": { # Reference to a resource.
              "description": "A String", # Description of the resource.
              "resourceName": "A String", # The resource name of the Google Cloud resource.
              "uri": "A String", # The URI of the resource.
              "useCase": "A String", # Use case (CUJ) of the resource.
            },
          },
          "resourceDescription": "A String", # Optional. Description of the resource.
          "resourceTitle": "A String", # Optional. Title of the resource.
          "resourceUseCase": "A String", # Optional. Use case (CUJ) of the resource.
          "supportsWorkbench": True or False, # Optional. For notebook resource, whether the notebook supports Workbench.
          "title": "A String", # Required.
        },
        "viewRestApi": { # Rest API docs. # Optional. To view Rest API docs.
          "documentations": [ # Required.
            { # A named piece of documentation.
              "content": "A String", # Required. Content of this piece of document (in Markdown format).
              "title": "A String", # Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, JAVA, NODE.JS, etc..
            },
          ],
          "title": "A String", # Required. The title of the view rest API.
        },
      },
      "versionId": "A String", # Output only. Immutable. The version ID of the PublisherModel. A new version is committed when a new model version is uploaded under an existing model id. It is an auto-incrementing decimal number in string representation.
      "versionState": "A String", # Optional. Indicates the state of the model version.
    },
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        

predict(endpoint, body=None, x__xgafv=None)

Perform an online prediction.

Args:
  endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for PredictionService.Predict.
  "instances": [ # Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.
    "",
  ],
  "parameters": "", # The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for PredictionService.Predict.
  "deployedModelId": "A String", # ID of the Endpoint's DeployedModel that served this prediction.
  "metadata": "", # Output only. Request-level metadata returned by the model. The metadata type will be dependent upon the model implementation.
  "model": "A String", # Output only. The resource name of the Model which is deployed as the DeployedModel that this prediction hits.
  "modelDisplayName": "A String", # Output only. The display name of the Model which is deployed as the DeployedModel that this prediction hits.
  "modelVersionId": "A String", # Output only. The version ID of the Model which is deployed as the DeployedModel that this prediction hits.
  "predictions": [ # The predictions that are the output of the predictions call. The schema of any single prediction may be specified via Endpoint's DeployedModels' Model's PredictSchemata's prediction_schema_uri.
    "",
  ],
}

predictLongRunning(endpoint, body=None, x__xgafv=None)

Args:
  endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for PredictionService.PredictLongRunning.
  "instances": [ # Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.
    "",
  ],
  "parameters": "", # Optional. The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}

streamGenerateContent(model, body=None, x__xgafv=None)

Generate content with multimodal inputs with streaming support.

Args:
  model: string, Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for [PredictionService.GenerateContent].
  "cachedContent": "A String", # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}`
  "contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.
    { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
      "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
        { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
          "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
            "outcome": "A String", # Required. Outcome of the code execution.
            "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
          },
          "executableCode": { # 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. # Optional. Code generated by the model that is meant to be executed.
            "code": "A String", # Required. The code to be executed.
            "language": "A String", # Required. Programming language of the `code`.
          },
          "fileData": { # URI based data. # Optional. URI based data.
            "displayName": "A 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": "A String", # Required. URI.
            "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
          },
          "functionCall": { # 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. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
            "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
              "a_key": "", # Properties of the object.
            },
            "id": "A 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": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
          },
          "functionResponse": { # 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. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
            "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
            "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
            "response": { # 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.
              "a_key": "", # Properties of the object.
            },
          },
          "inlineData": { # Content blob. # Optional. Inlined bytes data.
            "data": "A String", # Required. Raw bytes.
            "displayName": "A 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": "A String", # Required. The IANA standard MIME type of the source data.
          },
          "text": "A String", # Optional. Text part (can be code).
          "thought": True or False, # Optional. Indicates if the part is thought from the model.
          "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
          "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
            "endOffset": "A String", # Optional. The end offset of the video.
            "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
            "startOffset": "A String", # Optional. The start offset of the video.
          },
        },
      ],
      "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
    },
  ],
  "generationConfig": { # Generation config. # Optional. Generation config.
    "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
    "candidateCount": 42, # Optional. Number of candidates to generate.
    "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
    "frequencyPenalty": 3.14, # Optional. Frequency penalties.
    "logprobs": 42, # Optional. Logit probabilities.
    "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
    "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
    "modelConfig": { # Config for model selection. # Optional. Config for model selection.
      "featureSelectionPreference": "A String", # Required. Feature selection preference.
    },
    "presencePenalty": 3.14, # Optional. Positive penalties.
    "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
    "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
    "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
    "responseModalities": [ # Optional. The modalities of the response.
      "A String",
    ],
    "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
      "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
      "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
        # Object with schema name: GoogleCloudAiplatformV1beta1Schema
      ],
      "default": "", # Optional. Default value of the data.
      "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
        "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
      },
      "description": "A String", # Optional. The description of the data.
      "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
        "A String",
      ],
      "example": "", # Optional. Example of the object. Will only populated when the object is the root.
      "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
      "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
      "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
      "maxLength": "A String", # Optional. Maximum length of the Type.STRING
      "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
      "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
      "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
      "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
      "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
      "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
      "nullable": True or False, # Optional. Indicates if the value may be null.
      "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
      "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
        "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
      },
      "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
        "A String",
      ],
      "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `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": [ # Optional. Required properties of Type.OBJECT.
        "A String",
      ],
      "title": "A String", # Optional. The title of the Schema.
      "type": "A String", # Optional. The type of the data.
    },
    "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
      "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
        "modelRoutingPreference": "A String", # The model routing preference.
      },
      "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
        "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
      },
    },
    "seed": 42, # Optional. Seed.
    "speechConfig": { # The speech generation config. # Optional. The speech generation config.
      "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
      "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
        "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
          "voiceName": "A String", # The name of the preset voice to use.
        },
      },
    },
    "stopSequences": [ # Optional. Stop sequences.
      "A String",
    ],
    "temperature": 3.14, # Optional. Controls the randomness of predictions.
    "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
      "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
      "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
    },
    "topK": 3.14, # Optional. If specified, top-k sampling will be used.
    "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
  },
  "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
    "a_key": "A String",
  },
  "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
    "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization.
    "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization.
  },
  "safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
    { # Safety settings.
      "category": "A String", # Required. Harm category.
      "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.
      "threshold": "A String", # Required. The harm block threshold.
    },
  ],
  "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # 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.
    "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
      { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
        "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
          "outcome": "A String", # Required. Outcome of the code execution.
          "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
        },
        "executableCode": { # 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. # Optional. Code generated by the model that is meant to be executed.
          "code": "A String", # Required. The code to be executed.
          "language": "A String", # Required. Programming language of the `code`.
        },
        "fileData": { # URI based data. # Optional. URI based data.
          "displayName": "A 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": "A String", # Required. URI.
          "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
        },
        "functionCall": { # 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. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
          "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
            "a_key": "", # Properties of the object.
          },
          "id": "A 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": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
        },
        "functionResponse": { # 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. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
          "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
          "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
          "response": { # 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.
            "a_key": "", # Properties of the object.
          },
        },
        "inlineData": { # Content blob. # Optional. Inlined bytes data.
          "data": "A String", # Required. Raw bytes.
          "displayName": "A 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": "A String", # Required. The IANA standard MIME type of the source data.
        },
        "text": "A String", # Optional. Text part (can be code).
        "thought": True or False, # Optional. Indicates if the part is thought from the model.
        "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
        "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
          "endOffset": "A String", # Optional. The end offset of the video.
          "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
          "startOffset": "A String", # Optional. The start offset of the video.
        },
      },
    ],
    "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
  },
  "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request.
    "functionCallingConfig": { # Function calling config. # Optional. Function calling config.
      "allowedFunctionNames": [ # Optional. Function names to call. Only set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided.
        "A String",
      ],
      "mode": "A String", # Optional. Function calling mode.
    },
    "retrievalConfig": { # Retrieval config. # Optional. Retrieval config.
      "languageCode": "A String", # The language code of the user.
      "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
        "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
        "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
      },
    },
  },
  "tools": [ # 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.
    { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
      "codeExecution": { # 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. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
      },
      "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
        "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
          "A String",
        ],
      },
      "functionDeclarations": [ # 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.
        { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.
          "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
          "name": "A 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 and dashes, with a maximum length of 64.
          "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # 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
            "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
            "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
              # Object with schema name: GoogleCloudAiplatformV1beta1Schema
            ],
            "default": "", # Optional. Default value of the data.
            "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
            },
            "description": "A String", # Optional. The description of the data.
            "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
              "A String",
            ],
            "example": "", # Optional. Example of the object. Will only populated when the object is the root.
            "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
            "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
            "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
            "maxLength": "A String", # Optional. Maximum length of the Type.STRING
            "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
            "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
            "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
            "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
            "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
            "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
            "nullable": True or False, # Optional. Indicates if the value may be null.
            "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
            "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
            },
            "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
              "A String",
            ],
            "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `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": [ # Optional. Required properties of Type.OBJECT.
              "A String",
            ],
            "title": "A String", # Optional. The title of the Schema.
            "type": "A String", # Optional. The type of the data.
          },
          "parametersJsonSchema": "", # 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": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # 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.
            "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
            "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
              # Object with schema name: GoogleCloudAiplatformV1beta1Schema
            ],
            "default": "", # Optional. Default value of the data.
            "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
            },
            "description": "A String", # Optional. The description of the data.
            "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
              "A String",
            ],
            "example": "", # Optional. Example of the object. Will only populated when the object is the root.
            "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
            "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
            "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
            "maxLength": "A String", # Optional. Maximum length of the Type.STRING
            "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
            "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
            "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
            "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
            "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
            "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
            "nullable": True or False, # Optional. Indicates if the value may be null.
            "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
            "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
            },
            "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
              "A String",
            ],
            "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `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": [ # Optional. Required properties of Type.OBJECT.
              "A String",
            ],
            "title": "A String", # Optional. The title of the Schema.
            "type": "A String", # Optional. The type of the data.
          },
          "responseJsonSchema": "", # 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`.
        },
      ],
      "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model.
        "enableWidget": True or False, # Optional. If true, include the widget context token in the response.
      },
      "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
        "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
          "A String",
        ],
      },
      "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search.
        "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
          "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
          "mode": "A String", # The mode of the predictor to be used in dynamic retrieval.
        },
      },
      "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # 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.
        "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
        "externalApi": { # 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. # Use data source powered by external API for grounding.
          "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead.
            "apiKeyConfig": { # The API secret. # The API secret.
              "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
              "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set.
            },
          },
          "apiSpec": "A String", # The API spec that the external API implements.
          "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API.
            "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
              "apiKeySecret": "A 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": "A String", # Optional. The API key to be used in the request directly.
              "httpElementLocation": "A String", # Optional. The location of the API key.
              "name": "A 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": "A String", # Type of auth scheme.
            "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth.
              "serviceAccount": "A 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": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth.
              "credentialSecret": "A 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": { # Config for user oauth. # Config for user oauth.
              "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
              "serviceAccount": "A 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": { # Config for user OIDC auth. # Config for user OIDC auth.
              "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
              "serviceAccount": "A 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": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API.
            "index": "A String", # The ElasticSearch index to use.
            "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param.
            "searchTemplate": "A String", # The ElasticSearch search template to use.
          },
          "endpoint": "A 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": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API.
          },
        },
        "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
          "dataStoreSpecs": [ # 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.
            { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec
              "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
              "filter": "A 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": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
          "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
          "filter": "A String", # Optional. Filter strings to be passed to the search API.
          "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
        },
        "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
          "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead.
            "A String",
          ],
          "ragResources": [ # 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.
            { # The definition of the Rag resource.
              "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
              "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
                "A String",
              ],
            },
          ],
          "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
            "filter": { # Config for filters. # Optional. Config for filters.
              "metadataFilter": "A String", # Optional. String for metadata filtering.
              "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
              "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
            },
            "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search.
              "alpha": 3.14, # 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.
            },
            "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking.
              "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker.
                "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
              },
              "rankService": { # Config for Rank Service. # Optional. Config for Rank Service.
                "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`
              },
            },
            "topK": 42, # Optional. The number of contexts to retrieve.
          },
          "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora.
          "storeContext": True or False, # 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.
          "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
        },
      },
      "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval.
      },
    },
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for [PredictionService.GenerateContent].
  "candidates": [ # Output only. Generated candidates.
    { # A response candidate generated from the model.
      "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate.
      "citationMetadata": { # A collection of source attributions for a piece of content. # Output only. Source attribution of the generated content.
        "citations": [ # Output only. List of citations.
          { # Source attributions for content.
            "endIndex": 42, # Output only. End index into the content.
            "license": "A String", # Output only. License of the attribution.
            "publicationDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution.
              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
            },
            "startIndex": 42, # Output only. Start index into the content.
            "title": "A String", # Output only. Title of the attribution.
            "uri": "A String", # Output only. Url reference of the attribution.
          },
        ],
      },
      "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Output only. Content parts of the candidate.
        "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
          { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
            "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
              "outcome": "A String", # Required. Outcome of the code execution.
              "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
            },
            "executableCode": { # 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. # Optional. Code generated by the model that is meant to be executed.
              "code": "A String", # Required. The code to be executed.
              "language": "A String", # Required. Programming language of the `code`.
            },
            "fileData": { # URI based data. # Optional. URI based data.
              "displayName": "A 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": "A String", # Required. URI.
              "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
            },
            "functionCall": { # 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. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
              "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
                "a_key": "", # Properties of the object.
              },
              "id": "A 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": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
            },
            "functionResponse": { # 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. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
              "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
              "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
              "response": { # 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.
                "a_key": "", # Properties of the object.
              },
            },
            "inlineData": { # Content blob. # Optional. Inlined bytes data.
              "data": "A String", # Required. Raw bytes.
              "displayName": "A 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": "A String", # Required. The IANA standard MIME type of the source data.
            },
            "text": "A String", # Optional. Text part (can be code).
            "thought": True or False, # Optional. Indicates if the part is thought from the model.
            "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
            "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
              "endOffset": "A String", # Optional. The end offset of the video.
              "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
              "startOffset": "A String", # Optional. The start offset of the video.
            },
          },
        ],
        "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
      },
      "finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set.
      "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.
      "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content.
        "googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.
        "groundingChunks": [ # List of supporting references retrieved from specified grounding source.
          { # Grounding chunk.
            "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps.
              "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content.
                "reviewSnippets": [ # Snippets of reviews that are used to generate the answer.
                  { # Encapsulates a review snippet.
                    "googleMapsUri": "A String", # A link to show the review on Google Maps.
                    "reviewId": "A String", # Id of the review referencing the place.
                    "title": "A String", # Title of the review.
                  },
                ],
              },
              "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place.
              "text": "A String", # Text of the place answer.
              "title": "A String", # Title of the place.
              "uri": "A String", # URI reference of the place.
            },
            "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
              "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
              "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
                "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
                  "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
                  "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed.
                },
                "text": "A String", # The content of the chunk.
              },
              "text": "A String", # Text of the attribution.
              "title": "A String", # Title of the attribution.
              "uri": "A String", # URI reference of the attribution.
            },
            "web": { # Chunk from the web. # Grounding chunk from the web.
              "domain": "A String", # Domain of the (original) URI.
              "title": "A String", # Title of the chunk.
              "uri": "A String", # URI reference of the chunk.
            },
          },
        ],
        "groundingSupports": [ # Optional. List of grounding support.
          { # Grounding support.
            "confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored.
              3.14,
            ],
            "groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.
              42,
            ],
            "segment": { # Segment of the content. # Segment of the content this support belongs to.
              "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.
              "partIndex": 42, # Output only. The index of a Part object within its parent Content object.
              "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.
              "text": "A String", # Output only. The text corresponding to the segment from the response.
            },
          },
        ],
        "retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata.
          "googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.
        },
        "retrievalQueries": [ # Optional. Queries executed by the retrieval tools.
          "A String",
        ],
        "searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches.
          "renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview.
          "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple.
        },
        "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.
          { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding.
            "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review).
            "sourceId": "A String", # Id of the place or review.
          },
        ],
        "webSearchQueries": [ # Optional. Web search queries for the following-up web search.
          "A String",
        ],
      },
      "index": 42, # Output only. Index of the candidate.
      "logprobsResult": { # Logprobs Result # Output only. Log-likelihood scores for the response tokens and top tokens
        "chosenCandidates": [ # Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.
          { # Candidate for the logprobs token and score.
            "logProbability": 3.14, # The candidate's log probability.
            "token": "A String", # The candidate's token string value.
            "tokenId": 42, # The candidate's token id value.
          },
        ],
        "topCandidates": [ # Length = total number of decoding steps.
          { # Candidates with top log probabilities at each decoding step.
            "candidates": [ # Sorted by log probability in descending order.
              { # Candidate for the logprobs token and score.
                "logProbability": 3.14, # The candidate's log probability.
                "token": "A String", # The candidate's token string value.
                "tokenId": 42, # The candidate's token id value.
              },
            ],
          },
        ],
      },
      "safetyRatings": [ # Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.
        { # Safety rating corresponding to the generated content.
          "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating.
          "category": "A String", # Output only. Harm category.
          "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold.
          "probability": "A String", # Output only. Harm probability levels in the content.
          "probabilityScore": 3.14, # Output only. Harm probability score.
          "severity": "A String", # Output only. Harm severity levels in the content.
          "severityScore": 3.14, # Output only. Harm severity score.
        },
      ],
      "urlContextMetadata": { # Metadata related to url context retrieval tool. # Output only. Metadata related to url context retrieval tool.
        "urlMetadata": [ # Output only. List of url context.
          { # Context of the a single url retrieval.
            "retrievedUrl": "A String", # Retrieved url by the tool.
            "urlRetrievalStatus": "A String", # Status of the url retrieval.
          },
        ],
      },
    },
  ],
  "createTime": "A String", # Output only. Timestamp when the request is made to the server.
  "modelVersion": "A String", # Output only. The model version used to generate the response.
  "promptFeedback": { # Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations.
    "blockReason": "A String", # Output only. The reason why the prompt was blocked.
    "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked.
    "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category.
      { # Safety rating corresponding to the generated content.
        "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating.
        "category": "A String", # Output only. Harm category.
        "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold.
        "probability": "A String", # Output only. Harm probability levels in the content.
        "probabilityScore": 3.14, # Output only. Harm probability score.
        "severity": "A String", # Output only. Harm severity levels in the content.
        "severityScore": 3.14, # Output only. Harm severity score.
      },
    ],
  },
  "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id.
  "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s).
    "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content.
      { # Represents token counting info for a single modality.
        "modality": "A String", # The modality associated with this token count.
        "tokenCount": 42, # Number of tokens.
      },
    ],
    "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request.
    "candidatesTokenCount": 42, # The total number of tokens in the generated candidates.
    "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates.
      { # Represents token counting info for a single modality.
        "modality": "A String", # The modality associated with this token count.
        "tokenCount": 42, # Number of tokens.
      },
    ],
    "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content.
    "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt.
      { # Represents token counting info for a single modality.
        "modality": "A String", # The modality associated with this token count.
        "tokenCount": 42, # Number of tokens.
      },
    ],
    "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable.
    "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.
    "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
      { # Represents token counting info for a single modality.
        "modality": "A String", # The modality associated with this token count.
        "tokenCount": 42, # Number of tokens.
      },
    ],
    "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.
    "trafficType": "A String", # Output only. The traffic type for this request.
  },
}