google-api-python-client 2.169.0__py3-none-any.whl → 2.170.0__py3-none-any.whl

googleapiclient/discovery_cache/documents/aiplatform.v1.json

@@ -15785,7 +15785,7 @@
 ],
 "parameters": {
 "name": {
-"description": "Identifier. The resource name of the ReasoningEngine.",
+"description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
 "required": true,
@@ -19841,7 +19841,7 @@
 }
 }
 },
-"revision": "20250415",
+"revision": "20250502",
 "rootUrl": "https://aiplatform.googleapis.com/",
 "schemas": {
 "CloudAiLargeModelsVisionGenerateVideoResponse": {
@@ -21580,6 +21580,10 @@
 "description": "Optional. Immutable. The user-generated meaningful display name of the cached content.",
 "type": "string"
 },
+"encryptionSpec": {
+"$ref": "GoogleCloudAiplatformV1EncryptionSpec",
+"description": "Input only. Immutable. Customer-managed encryption key spec for a `CachedContent`. If set, this `CachedContent` and all its sub-resources will be secured by this key."
+},
 "expireTime": {
 "description": "Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input.",
 "format": "google-datetime",
@@ -21824,6 +21828,27 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1Checkpoint": {
+"description": "Describes the machine learning model version checkpoint.",
+"id": "GoogleCloudAiplatformV1Checkpoint",
+"properties": {
+"checkpointId": {
+"description": "The ID of the checkpoint.",
+"type": "string"
+},
+"epoch": {
+"description": "The epoch of the checkpoint.",
+"format": "int64",
+"type": "string"
+},
+"step": {
+"description": "The step of the checkpoint.",
+"format": "int64",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1Citation": {
 "description": "Source attributions for content.",
 "id": "GoogleCloudAiplatformV1Citation",
@@ -23805,6 +23830,10 @@
 "$ref": "GoogleCloudAiplatformV1AutomaticResources",
 "description": "A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration."
 },
+"checkpointId": {
+"description": "The checkpoint id of the model.",
+"type": "string"
+},
 "createTime": {
 "description": "Output only. Timestamp when the DeployedModel was created.",
 "format": "google-datetime",
@@ -23888,6 +23917,10 @@
 "description": "Points to a DeployedModel.",
 "id": "GoogleCloudAiplatformV1DeployedModelRef",
 "properties": {
+"checkpointId": {
+"description": "Immutable. The ID of the Checkpoint deployed in the DeployedModel.",
+"type": "string"
+},
 "deployedModelId": {
 "description": "Immutable. An ID of a DeployedModel in the above Endpoint.",
 "type": "string"
@@ -27973,6 +28006,10 @@
 "description": "Config for thinking features.",
 "id": "GoogleCloudAiplatformV1GenerationConfigThinkingConfig",
 "properties": {
+"includeThoughts": {
+"description": "Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.",
+"type": "boolean"
+},
 "thinkingBudget": {
 "description": "Optional. Indicates the thinking budget in tokens. This is only applied when enable_thinking is true.",
 "format": "int32",
@@ -30276,6 +30313,7 @@
 "NVIDIA_H100_80GB",
 "NVIDIA_H100_MEGA_80GB",
 "NVIDIA_H200_141GB",
+"NVIDIA_B200",
 "TPU_V2",
 "TPU_V3",
 "TPU_V4_POD",
@@ -30297,6 +30335,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -30312,6 +30351,7 @@ false
 "Nvidia H100 80Gb GPU.",
 "Nvidia H100 Mega 80Gb GPU.",
 "Nvidia H200 141Gb GPU.",
+"Nvidia B200 GPU.",
 "TPU v2.",
 "TPU v3.",
 "TPU v4.",
@@ -30942,6 +30982,14 @@ false
 "$ref": "GoogleCloudAiplatformV1ModelBaseModelSource",
 "description": "Optional. User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models."
 },
+"checkpoints": {
+"description": "Optional. Output only. The checkpoints of the model.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1Checkpoint"
+},
+"readOnly": true,
+"type": "array"
+},
 "containerSpec": {
 "$ref": "GoogleCloudAiplatformV1ModelContainerSpec",
 "description": "Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models."
@@ -32080,6 +32128,7 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1ModelVersionCheckpoint": {
+"deprecated": true,
 "description": "Describes the machine learning model version checkpoint.",
 "id": "GoogleCloudAiplatformV1ModelVersionCheckpoint",
 "properties": {
@@ -32092,10 +32141,6 @@ false
 "format": "int64",
 "type": "string"
 },
-"name": {
-"description": "Identifier. The resource name of the ModelVersionCheckpoint. Format: `projects/{project}/locations/{location}/models/{model}/versions/{version}/checkpoints/{checkpoint}`",
-"type": "string"
-},
 "step": {
 "description": "The step of the checkpoint.",
 "format": "int64",
@@ -32750,7 +32795,8 @@ false
 "INVALID_TOKEN_VALUE",
 "INVALID_SPARSE_EMBEDDING",
 "INVALID_EMBEDDING",
-"INVALID_EMBEDDING_METADATA"
+"INVALID_EMBEDDING_METADATA",
+"EMBEDDING_METADATA_EXCEEDS_SIZE_LIMIT"
 ],
 "enumDescriptions": [
 "Default, shall not be used.",
@@ -32771,7 +32817,8 @@ false
 "Token restrict value is invalid.",
 "Invalid sparse embedding.",
 "Invalid dense embedding.",
-"Invalid embedding metadata."
+"Invalid embedding metadata.",
+"Embedding metadata exceeds size limit."
 ],
 "type": "string"
 },
@@ -33136,7 +33183,7 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1NotebookRuntime": {
-"description": "A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours.",
+"description": "A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime. Default runtimes have a lifetime of 18 hours, while custom runtimes last for 6 months from their creation or last upgrade.",
 "id": "GoogleCloudAiplatformV1NotebookRuntime",
 "properties": {
 "createTime": {
@@ -33273,7 +33320,7 @@ false
 "enumDescriptions": [
 "Unspecified runtime state.",
 "NotebookRuntime is in running state.",
-"NotebookRuntime is in starting state.",
+"NotebookRuntime is in starting state. This is when the runtime is being started from a stopped state.",
 "NotebookRuntime is in stopping state.",
 "NotebookRuntime is in stopped state.",
 "NotebookRuntime is in upgrading state. It is in the middle of upgrading process.",
@@ -33448,7 +33495,7 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1NotebookSoftwareConfig": {
-"description": "Notebook Software Config.",
+"description": "Notebook Software Config. This is passed to the backend when user makes software configurations in UI.",
 "id": "GoogleCloudAiplatformV1NotebookSoftwareConfig",
 "properties": {
 "env": {
@@ -36071,6 +36118,10 @@ false
 "layoutParser": {
 "$ref": "GoogleCloudAiplatformV1RagFileParsingConfigLayoutParser",
 "description": "The Layout Parser to use for RagFiles."
+},
+"llmParser": {
+"$ref": "GoogleCloudAiplatformV1RagFileParsingConfigLlmParser",
+"description": "The LLM Parser to use for RagFiles."
 }
 },
 "type": "object"
@@ -36091,6 +36142,26 @@ false
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1RagFileParsingConfigLlmParser": {
+"description": "Specifies the advanced parsing for RagFiles.",
+"id": "GoogleCloudAiplatformV1RagFileParsingConfigLlmParser",
+"properties": {
+"customParsingPrompt": {
+"description": "The prompt to use for parsing. If not specified, a default prompt will be used.",
+"type": "string"
+},
+"maxParsingRequestsPerMin": {
+"description": "The maximum number of requests the job is allowed to make to the LLM model per minute. Consult https://cloud.google.com/vertex-ai/generative-ai/docs/quotas and your document size to set an appropriate value here. If unspecified, a default value of 5000 QPM would be used.",
+"format": "int32",
+"type": "integer"
+},
+"modelName": {
+"description": "The name of a LLM model used for parsing. Format: * `projects/{project_id}/locations/{location}/publishers/{publisher}/models/{model}`",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1RagFileTransformationConfig": {
 "description": "Specifies the transformation config for RagFiles.",
 "id": "GoogleCloudAiplatformV1RagFileTransformationConfig",
@@ -36560,7 +36631,7 @@ false
 "type": "string"
 },
 "name": {
-"description": "Identifier. The resource name of the ReasoningEngine.",
+"description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
 "type": "string"
 },
 "spec": {
@@ -37196,13 +37267,21 @@ false
 "HARM_CATEGORY_SEXUALLY_EXPLICIT",
 "HARM_CATEGORY_CIVIC_INTEGRITY"
 ],
+"enumDeprecated": [
+false,
+false,
+false,
+false,
+false,
+true
+],
 "enumDescriptions": [
 "The harm category is unspecified.",
 "The harm category is hate speech.",
 "The harm category is dangerous content.",
 "The harm category is harassment.",
 "The harm category is sexually explicit content.",
-"The harm category is civic integrity."
+"Deprecated: Election filter is not longer supported. The harm category is civic integrity."
 ],
 "readOnly": true,
 "type": "string"
@@ -37298,13 +37377,21 @@ false
 "HARM_CATEGORY_SEXUALLY_EXPLICIT",
 "HARM_CATEGORY_CIVIC_INTEGRITY"
 ],
+"enumDeprecated": [
+false,
+false,
+false,
+false,
+false,
+true
+],
 "enumDescriptions": [
 "The harm category is unspecified.",
 "The harm category is hate speech.",
 "The harm category is dangerous content.",
 "The harm category is harassment.",
 "The harm category is sexually explicit content.",
-"The harm category is civic integrity."
+"Deprecated: Election filter is not longer supported. The harm category is civic integrity."
 ],
 "type": "string"
 },
@@ -37676,6 +37763,10 @@ false
 "description": "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.",
 "id": "GoogleCloudAiplatformV1Schema",
 "properties": {
+"additionalProperties": {
+"description": "Optional. Can either be a boolean or an object; controls the presence of additional properties.",
+"type": "any"
+},
 "anyOf": {
 "description": "Optional. The value should be validated against any (one or more) of the subschemas in the list.",
 "items": {
@@ -37687,6 +37778,13 @@ false
 "description": "Optional. Default value of the data.",
 "type": "any"
 },
+"defs": {
+"additionalProperties": {
+"$ref": "GoogleCloudAiplatformV1Schema"
+},
+"description": "Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.",
+"type": "object"
+},
 "description": {
 "description": "Optional. The description of the data.",
 "type": "string"
@@ -37772,6 +37870,10 @@ false
 },
 "type": "array"
 },
+"ref": {
+"description": "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",
+"type": "string"
+},
 "required": {
 "description": "Optional. Required properties of Type.OBJECT.",
 "items": {
@@ -37792,7 +37894,8 @@ false
 "INTEGER",
 "BOOLEAN",
 "ARRAY",
-"OBJECT"
+"OBJECT",
+"NULL"
 ],
 "enumDescriptions": [
 "Not specified, should not be used.",
@@ -37801,7 +37904,8 @@ false
 "OpenAPI integer type",
 "OpenAPI boolean type",
 "OpenAPI array type",
-"OpenAPI object type"
+"OpenAPI object type",
+"Null type"
 ],
 "type": "string"
 }
@@ -43456,7 +43560,7 @@ false
 "id": "GoogleCloudAiplatformV1SupervisedTuningDataStats",
 "properties": {
 "droppedExampleReasons": {
-"description": "Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. Must not include example itself.",
+"description": "Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped.",
 "items": {
 "type": "string"
 },
@@ -43627,6 +43731,10 @@ false
 "description": "Tuning Spec for Supervised Tuning for first party models.",
 "id": "GoogleCloudAiplatformV1SupervisedTuningSpec",
 "properties": {
+"exportLastCheckpointOnly": {
+"description": "Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false.",
+"type": "boolean"
+},
 "hyperParameters": {
 "$ref": "GoogleCloudAiplatformV1SupervisedHyperParameters",
 "description": "Optional. Hyperparameters for SFT."
@@ -45259,6 +45367,14 @@ false
 "description": "The Model Registry Model and Online Prediction Endpoint associated with this TuningJob.",
 "id": "GoogleCloudAiplatformV1TunedModel",
 "properties": {
+"checkpoints": {
+"description": "Output only. The checkpoints associated with this TunedModel. This field is only populated for tuning jobs that enable intermediate checkpoints.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1TunedModelCheckpoint"
+},
+"readOnly": true,
+"type": "array"
+},
 "endpoint": {
 "description": "Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.",
 "readOnly": true,
@@ -45272,6 +45388,31 @@ false
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1TunedModelCheckpoint": {
+"description": "TunedModelCheckpoint for the Tuned Model of a Tuning Job.",
+"id": "GoogleCloudAiplatformV1TunedModelCheckpoint",
+"properties": {
+"checkpointId": {
+"description": "The ID of the checkpoint.",
+"type": "string"
+},
+"endpoint": {
+"description": "The Endpoint resource name that the checkpoint is deployed to. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.",
+"type": "string"
+},
+"epoch": {
+"description": "The epoch of the checkpoint.",
+"format": "int64",
+"type": "string"
+},
+"step": {
+"description": "The step of the checkpoint.",
+"format": "int64",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1TunedModelRef": {
 "description": "TunedModel Reference for legacy model migration.",
 "id": "GoogleCloudAiplatformV1TunedModelRef",
@@ -45866,6 +46007,15 @@ false
 "engine": {
 "description": "Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`",
 "type": "string"
+},
+"filter": {
+"description": "Optional. Filter strings to be passed to the search API.",
+"type": "string"
+},
+"maxResults": {
+"description": "Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.",
+"format": "int32",
+"type": "integer"
 }
 },
 "type": "object"