google-api-python-client 2.163.0__py2.py3-none-any.whl → 2.165.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json

@@ -985,7 +985,7 @@
 ]
 },
 "deploy": {
-"description": "Deploys publisher models.",
+"description": "Deploys a model to a new endpoint.",
 "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:deploy",
 "httpMethod": "POST",
 "id": "aiplatform.projects.locations.deploy",
@@ -1003,6 +1003,35 @@
 },
 "path": "v1beta1/{+destination}:deploy",
 "request": {
+"$ref": "GoogleCloudAiplatformV1beta1DeployRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"deployPublisherModel": {
+"deprecated": true,
+"description": "Deploys publisher models.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:deployPublisherModel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.deployPublisherModel",
+"parameterOrder": [
+"destination"
+],
+"parameters": {
+"destination": {
+"description": "Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+destination}:deployPublisherModel",
+"request": {
 "$ref": "GoogleCloudAiplatformV1beta1DeployPublisherModelRequest"
 },
 "response": {
@@ -21941,6 +21970,11 @@
 "location": "query",
 "type": "string"
 },
+"includeEquivalentModelGardenModelDeploymentConfigs": {
+"description": "Optional. Whether to cnclude the deployment configs from the equivalent Model Garden model if the requested model is a Hugging Face model.",
+"location": "query",
+"type": "boolean"
+},
 "isHuggingFaceModel": {
 "description": "Optional. Boolean indicates whether the requested model is a Hugging Face model.",
 "location": "query",
@@ -22120,7 +22154,7 @@
 }
 }
 },
-"revision": "20250212",
+"revision": "20250304",
 "rootUrl": "https://aiplatform.googleapis.com/",
 "schemas": {
 "CloudAiLargeModelsVisionGenerateVideoResponse": {
@@ -22145,6 +22179,31 @@
 "type": "string"
 },
 "type": "array"
+},
+"videos": {
+"description": "List of videos, used to align naming with the external response.",
+"items": {
+"$ref": "CloudAiLargeModelsVisionGenerateVideoResponseVideo"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"CloudAiLargeModelsVisionGenerateVideoResponseVideo": {
+"id": "CloudAiLargeModelsVisionGenerateVideoResponseVideo",
+"properties": {
+"bytesBase64Encoded": {
+"description": "Base64 encoded bytes string representing the video.",
+"type": "string"
+},
+"gcsUri": {
+"description": "Cloud Storage URI where the generated video is written.",
+"type": "string"
+},
+"mimeType": {
+"description": "The MIME type of the content of the video. - video/mp4",
+"type": "string"
 }
 },
 "type": "object"
@@ -22424,6 +22483,10 @@
 "description": "Video encoding, for example \"video/mp4\".",
 "type": "string"
 },
+"text": {
+"description": "Text/Expanded text input for Help Me Write.",
+"type": "string"
+},
 "uri": {
 "description": "Path to another storage (typically Google Cloud Storage).",
 "type": "string"
@@ -23041,7 +23104,7 @@
 "type": "string"
 },
 "httpElementLocation": {
-"description": "Required. The location of the API key.",
+"description": "Optional. The location of the API key.",
 "enum": [
 "HTTP_IN_UNSPECIFIED",
 "HTTP_IN_QUERY",
@@ -23061,7 +23124,7 @@
 "type": "string"
 },
 "name": {
-"description": "Required. 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.",
+"description": "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.",
 "type": "string"
 }
 },
@@ -26275,6 +26338,7 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1DeployPublisherModelRequest": {
+"deprecated": true,
 "description": "Request message for ModelGardenService.DeployPublisherModel.",
 "id": "GoogleCloudAiplatformV1beta1DeployPublisherModelRequest",
 "properties": {
@@ -26295,9 +26359,93 @@
 "type": "string"
 },
 "model": {
-"description": "Required. The model to deploy. Format: 1. `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`. 2. Hugging Face model ID like `google/gemma-2-2b-it`. 3. Custom model Google Cloud Storage URI like `gs://bucket`. 4. Custom model zip file like `https://abc.com/a.zip`.",
+"description": "Required. The model to deploy. Format: 1. `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`. 2. Hugging Face model ID like `google/gemma-2-2b-it`. 3. Custom model Google Cloud Storage URI like `gs://bucket`. 4. Custom model zip file like `https://example.com/a.zip`.",
+"type": "string"
+},
+"modelDisplayName": {
+"description": "Optional. The user-specified display name of the uploaded model. If not set, a default name will be used.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1beta1DeployRequest": {
+"description": "Request message for ModelGardenService.Deploy.",
+"id": "GoogleCloudAiplatformV1beta1DeployRequest",
+"properties": {
+"deployConfig": {
+"$ref": "GoogleCloudAiplatformV1beta1DeployRequestDeployConfig",
+"description": "Optional. The deploy config to use for the deployment. If not specified, the default deploy config will be used."
+},
+"endpointConfig": {
+"$ref": "GoogleCloudAiplatformV1beta1DeployRequestEndpointConfig",
+"description": "Optional. The endpoint config to use for the deployment. If not specified, the default endpoint config will be used."
+},
+"huggingFaceModelId": {
+"description": "The Hugging Face model to deploy. Format: Hugging Face model ID like `google/gemma-2-2b-it`.",
+"type": "string"
+},
+"modelConfig": {
+"$ref": "GoogleCloudAiplatformV1beta1DeployRequestModelConfig",
+"description": "Optional. The model config to use for the deployment. If not specified, the default model config will be used."
+},
+"publisherModelName": {
+"description": "The Model Garden model to deploy. Format: `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1beta1DeployRequestDeployConfig": {
+"description": "The deploy config to use for the deployment.",
+"id": "GoogleCloudAiplatformV1beta1DeployRequestDeployConfig",
+"properties": {
+"dedicatedResources": {
+"$ref": "GoogleCloudAiplatformV1beta1DedicatedResources",
+"description": "Optional. The dedicated resources to use for the endpoint. If not set, the default resources will be used."
+},
+"fastTryoutEnabled": {
+"description": "Optional. If true, enable the QMT fast tryout feature for this model if possible.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1beta1DeployRequestEndpointConfig": {
+"description": "The endpoint config to use for the deployment.",
+"id": "GoogleCloudAiplatformV1beta1DeployRequestEndpointConfig",
+"properties": {
+"dedicatedEndpointEnabled": {
+"description": "Optional. If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon.",
+"type": "boolean"
+},
+"endpointDisplayName": {
+"description": "Optional. The user-specified display name of the endpoint. If not set, a default name will be used.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1beta1DeployRequestModelConfig": {
+"description": "The model config to use for the deployment.",
+"id": "GoogleCloudAiplatformV1beta1DeployRequestModelConfig",
+"properties": {
+"acceptEula": {
+"description": "Optional. Whether the user accepts the End User License Agreement (EULA) for the model.",
+"type": "boolean"
+},
+"containerSpec": {
+"$ref": "GoogleCloudAiplatformV1beta1ModelContainerSpec",
+"description": "Optional. The specification of the container that is to be used when deploying. If not set, the default container spec will be used."
+},
+"huggingFaceAccessToken": {
+"description": "Optional. The Hugging Face read access token used to access the model artifacts of gated models.",
 "type": "string"
 },
+"huggingFaceCacheEnabled": {
+"description": "Optional. If true, the model will deploy with a cached version instead of directly downloading the model artifacts from Hugging Face. This is suitable for VPC-SC users with limited internet access.",
+"type": "boolean"
+},
 "modelDisplayName": {
 "description": "Optional. The user-specified display name of the uploaded model. If not set, a default name will be used.",
 "type": "string"
@@ -26705,7 +26853,7 @@
 "type": "integer"
 },
 "bootDiskType": {
-"description": "Type of the boot disk (default is \"pd-ssd\"). Valid values: \"pd-ssd\" (Persistent Disk Solid State Drive) or \"pd-standard\" (Persistent Disk Hard Disk Drive).",
+"description": "Type of the boot disk. For non-A3U machines, the default value is \"pd-ssd\", for A3U machines, the default value is \"hyperdisk-balanced\". Valid values: \"pd-ssd\" (Persistent Disk Solid State Drive), \"pd-standard\" (Persistent Disk Hard Disk Drive) or \"hyperdisk-balanced\".",
 "type": "string"
 }
 },
@@ -26732,6 +26880,7 @@
 "enum": [
 "ADAPTER_SIZE_UNSPECIFIED",
 "ADAPTER_SIZE_ONE",
+"ADAPTER_SIZE_TWO",
 "ADAPTER_SIZE_FOUR",
 "ADAPTER_SIZE_EIGHT",
 "ADAPTER_SIZE_SIXTEEN",
@@ -26740,6 +26889,7 @@
 "enumDescriptions": [
 "Adapter size is unspecified.",
 "Adapter size 1.",
+"Adapter size 2.",
 "Adapter size 4.",
 "Adapter size 8.",
 "Adapter size 16.",
@@ -26960,6 +27110,12 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1beta1EnterpriseWebSearch": {
+"description": "Tool to search public web data, powered by Vertex AI Search and Sec4 compliance.",
+"id": "GoogleCloudAiplatformV1beta1EnterpriseWebSearch",
+"properties": {},
+"type": "object"
+},
 "GoogleCloudAiplatformV1beta1EntityIdSelector": {
 "description": "Selector for entityId. Getting ids from the given source.",
 "id": "GoogleCloudAiplatformV1beta1EntityIdSelector",
@@ -30980,8 +31136,28 @@
 "readOnly": true,
 "type": "array"
 },
+"thoughtsTokenCount": {
+"description": "Output only. Number of tokens present in thoughts output.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"toolUsePromptTokenCount": {
+"description": "Output only. Number of tokens present in tool-use prompt(s).",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"toolUsePromptTokensDetails": {
+"description": "Output only. List of modalities that were processed for tool-use request inputs.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount"
+},
+"readOnly": true,
+"type": "array"
+},
 "totalTokenCount": {
-"description": "Total token count for prompt and response candidates.",
+"description": "Total token count for prompt, response candidates, and tool-use prompts (if present).",
 "format": "int32",
 "type": "integer"
 }
@@ -30993,6 +31169,7 @@
 "id": "GoogleCloudAiplatformV1beta1GenerateVideoResponse",
 "properties": {
 "generatedSamples": {
+"deprecated": true,
 "description": "The cloud storage uris of the generated videos.",
 "items": {
 "type": "string"
@@ -31010,6 +31187,32 @@
 "type": "string"
 },
 "type": "array"
+},
+"videos": {
+"description": "List of video bytes or Cloud Storage URIs of the generated videos.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1beta1GenerateVideoResponseVideo"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1beta1GenerateVideoResponseVideo": {
+"description": "A generated video.",
+"id": "GoogleCloudAiplatformV1beta1GenerateVideoResponseVideo",
+"properties": {
+"bytesBase64Encoded": {
+"description": "Base64 encoded bytes string representing the video.",
+"type": "string"
+},
+"gcsUri": {
+"description": "Cloud Storage URI where the generated video is written.",
+"type": "string"
+},
+"mimeType": {
+"description": "The MIME type of the content of the video. - video/mp4",
+"type": "string"
 }
 },
 "type": "object"
@@ -33688,6 +33891,11 @@ false
 "description": "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.",
 "type": "string"
 },
+"multihostGpuNodeCount": {
+"description": "Optional. Immutable. The number of nodes per replica for multihost GPU deployments.",
+"format": "int32",
+"type": "integer"
+},
 "reservationAffinity": {
 "$ref": "GoogleCloudAiplatformV1beta1ReservationAffinity",
 "description": "Optional. Immutable. Configuration controlling how this resource pool consumes reservation."
@@ -41085,6 +41293,10 @@ false
 },
 "type": "array"
 },
+"deploymentSpec": {
+"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec",
+"description": "Optional. The specification of a Reasoning Engine deployment."
+},
 "packageSpec": {
 "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecPackageSpec",
 "description": "Required. User provided package spec of the ReasoningEngine."
@@ -41092,6 +41304,27 @@ false
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec": {
+"description": "The specification of a Reasoning Engine deployment.",
+"id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec",
+"properties": {
+"env": {
+"description": "Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1beta1EnvVar"
+},
+"type": "array"
+},
+"secretEnv": {
+"description": "Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1beta1SecretEnvVar"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1beta1ReasoningEngineSpecPackageSpec": {
 "description": "User provided package spec like pickled object and package requirements.",
 "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecPackageSpec",
@@ -41319,7 +41552,7 @@ false
 "type": "string"
 },
 "values": {
-"description": "Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.",
+"description": "Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block.",
 "items": {
 "type": "string"
 },
@@ -46896,6 +47129,36 @@ false
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1beta1SecretEnvVar": {
+"description": "Represents an environment variable where the value is a secret in Cloud Secret Manager.",
+"id": "GoogleCloudAiplatformV1beta1SecretEnvVar",
+"properties": {
+"name": {
+"description": "Required. Name of the secret environment variable.",
+"type": "string"
+},
+"secretRef": {
+"$ref": "GoogleCloudAiplatformV1beta1SecretRef",
+"description": "Required. Reference to a secret stored in the Cloud Secret Manager that will provide the value for this environment variable."
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1beta1SecretRef": {
+"description": "Reference to a secret stored in the Cloud Secret Manager that will provide the value for this environment variable.",
+"id": "GoogleCloudAiplatformV1beta1SecretRef",
+"properties": {
+"secret": {
+"description": "Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project.",
+"type": "string"
+},
+"version": {
+"description": "The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1beta1Segment": {
 "description": "Segment of the content.",
 "id": "GoogleCloudAiplatformV1beta1Segment",
@@ -48281,6 +48544,7 @@ false
 "enum": [
 "ADAPTER_SIZE_UNSPECIFIED",
 "ADAPTER_SIZE_ONE",
+"ADAPTER_SIZE_TWO",
 "ADAPTER_SIZE_FOUR",
 "ADAPTER_SIZE_EIGHT",
 "ADAPTER_SIZE_SIXTEEN",
@@ -48289,6 +48553,7 @@ false
 "enumDescriptions": [
 "Adapter size is unspecified.",
 "Adapter size 1.",
+"Adapter size 2.",
 "Adapter size 4.",
 "Adapter size 8.",
 "Adapter size 16.",
@@ -49101,7 +49366,11 @@ false
 "properties": {
 "codeExecution": {
 "$ref": "GoogleCloudAiplatformV1beta1ToolCodeExecution",
-"description": "Optional. CodeExecution tool type. Enables the model to execute code as part of generation. This field is only used by the Gemini Developer API services."
+"description": "Optional. CodeExecution tool type. Enables the model to execute code as part of generation."
+},
+"enterpriseWebSearch": {
+"$ref": "GoogleCloudAiplatformV1beta1EnterpriseWebSearch",
+"description": "Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance."
 },
 "functionDeclarations": {
 "description": "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 128 function declarations can be provided.",
@@ -50814,11 +51083,11 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1VertexAISearch": {
-"description": "Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder",
+"description": "Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder",
 "id": "GoogleCloudAiplatformV1beta1VertexAISearch",
 "properties": {
 "datastore": {
-"description": "Required. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`",
+"description": "Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`",
 "type": "string"
 }
 },