{ "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "id": "aiplatform:v1beta1", "discoveryVersion": "v1", "name": "aiplatform", "endpoints": [ { "endpointUrl": "https://africa-south1-aiplatform.googleapis.com/", "location": "africa-south1", "description": "Locational Endpoint" }, { "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/", "description": "Locational Endpoint", "location": "asia-east1" }, { "description": "Locational Endpoint", "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/", "location": "asia-east2" }, { "description": "Locational Endpoint", "location": "asia-northeast1", "endpointUrl": "https://asia-northeast1-aiplatform.googleapis.com/" }, { "endpointUrl": "https://asia-northeast2-aiplatform.googleapis.com/", "description": "Locational Endpoint", "location": "asia-northeast2" }, { "location": "asia-northeast3", "endpointUrl": "https://asia-northeast3-aiplatform.googleapis.com/", "description": "Locational Endpoint" }, { "location": "asia-south1", "description": "Locational Endpoint", "endpointUrl": "https://asia-south1-aiplatform.googleapis.com/" }, { "description": "Locational Endpoint", "location": "asia-south2", "endpointUrl": "https://asia-south2-aiplatform.googleapis.com/" }, { "description": "Locational Endpoint", "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/", "location": "asia-southeast1" }, { "endpointUrl": "https://asia-southeast2-aiplatform.googleapis.com/", "description": "Locational Endpoint", "location": "asia-southeast2" }, { "endpointUrl": "https://australia-southeast1-aiplatform.googleapis.com/", "description": "Locational Endpoint", "location": "australia-southeast1" }, { "location": "australia-southeast2", "endpointUrl": "https://australia-southeast2-aiplatform.googleapis.com/", "description": "Locational Endpoint" }, { "location": "europe-central2", "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/", "description": "Locational Endpoint" }, { "location": "europe-north1", "endpointUrl": "https://europe-north1-aiplatform.googleapis.com/", "description": "Locational Endpoint" }, { "endpointUrl": "https://europe-north2-aiplatform.googleapis.com/", "location": "europe-north2", "description": "Locational Endpoint" }, { "location": "europe-southwest1", "description": "Locational Endpoint", "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/" }, { "location": "europe-west1", "endpointUrl": "https://europe-west1-aiplatform.googleapis.com/", "description": "Locational Endpoint" }, { "endpointUrl": "https://europe-west10-aiplatform.googleapis.com/", "description": "Locational Endpoint", "location": "europe-west10" }, { "endpointUrl": "https://europe-west15-aiplatform.googleapis.com/", "location": "europe-west15", "description": "Locational Endpoint" }, { "location": "europe-west2", "description": "Locational Endpoint", "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/" }, { "location": "europe-west3", "endpointUrl": "https://europe-west3-aiplatform.googleapis.com/", "description": "Locational Endpoint" }, { "description": "Locational Endpoint", "location": "europe-west4", "endpointUrl": "https://europe-west4-aiplatform.googleapis.com/" }, { "description": "Locational Endpoint", "location": "europe-west6", "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/" }, { "location": "europe-west8", "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/", "description": "Locational Endpoint" }, { "endpointUrl": "https://europe-west9-aiplatform.googleapis.com/", "description": "Locational Endpoint", "location": "europe-west9" }, { "description": "Locational Endpoint", "location": "europe-west12", "endpointUrl": "https://europe-west12-aiplatform.googleapis.com/" }, { "description": "Locational Endpoint", "endpointUrl": "https://me-central1-aiplatform.googleapis.com/", "location": "me-central1" }, { "endpointUrl": "https://me-central2-aiplatform.googleapis.com/", "description": "Locational Endpoint", "location": "me-central2" }, { "location": "me-west1", "endpointUrl": "https://me-west1-aiplatform.googleapis.com/", "description": "Locational Endpoint" }, { "location": "northamerica-northeast1", "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/", "description": "Locational Endpoint" }, { "location": "northamerica-northeast2", "description": "Locational Endpoint", "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/" }, { "location": "southamerica-east1", "description": "Locational Endpoint", "endpointUrl": "https://southamerica-east1-aiplatform.googleapis.com/" }, { "endpointUrl": "https://southamerica-west1-aiplatform.googleapis.com/", "description": "Locational Endpoint", "location": "southamerica-west1" }, { "location": "us-central1", "description": "Locational Endpoint", "endpointUrl": "https://us-central1-aiplatform.googleapis.com/" }, { "description": "Locational Endpoint", "endpointUrl": "https://us-central2-aiplatform.googleapis.com/", "location": "us-central2" }, { "endpointUrl": "https://us-east1-aiplatform.googleapis.com/", "description": "Locational Endpoint", "location": "us-east1" }, { "location": "us-east4", "endpointUrl": "https://us-east4-aiplatform.googleapis.com/", "description": "Locational Endpoint" }, { "location": "us-east7", "description": "Locational Endpoint", "endpointUrl": "https://us-east7-aiplatform.googleapis.com/" }, { "description": "Locational Endpoint", "endpointUrl": "https://us-south1-aiplatform.googleapis.com/", "location": "us-south1" }, { "location": "us-west1", "endpointUrl": "https://us-west1-aiplatform.googleapis.com/", "description": "Locational Endpoint" }, { "location": "us-west2", "endpointUrl": "https://us-west2-aiplatform.googleapis.com/", "description": "Locational Endpoint" }, { "description": "Locational Endpoint", "location": "us-west3", "endpointUrl": "https://us-west3-aiplatform.googleapis.com/" }, { "description": "Locational Endpoint", "endpointUrl": "https://us-west4-aiplatform.googleapis.com/", "location": "us-west4" }, { "endpointUrl": "https://us-east5-aiplatform.googleapis.com/", "description": "Locational Endpoint", "location": "us-east5" }, { "endpointUrl": "https://us-west8-aiplatform.googleapis.com/", "description": "Locational Endpoint", "location": "us-west8" }, { "endpointUrl": "https://aiplatform.us.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us" }, { "endpointUrl": "https://aiplatform.eu.rep.googleapis.com/", "description": "Regional Endpoint", "location": "eu" } ], "ownerName": "Google", "title": "Agent Platform API", "version": "v1beta1", "kind": "discovery#restDescription", "parameters": { "fields": { "type": "string", "location": "query", "description": "Selector specifying which fields to include in a partial response." }, "key": { "location": "query", "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, "$.xgafv": { "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "description": "V1 error format.", "location": "query", "type": "string" }, "quotaUser": { "location": "query", "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "alt": { "description": "Data format for response.", "default": "json", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query", "enum": [ "json", "media", "proto" ], "type": "string" }, "prettyPrint": { "type": "boolean", "location": "query", "default": "true", "description": "Returns response with indentations and line breaks." }, "callback": { "description": "JSONP", "location": "query", "type": "string" }, "uploadType": { "type": "string", "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "access_token": { "location": "query", "description": "OAuth access token.", "type": "string" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "location": "query", "type": "string" }, "upload_protocol": { "location": "query", "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." } }, "documentationLink": "https://cloud.google.com/vertex-ai/", "rootUrl": "https://aiplatform.googleapis.com/", "servicePath": "", "basePath": "", "version_module": true, "resources": { "evaluationSets": { "resources": { "operations": { "methods": { "wait": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/evaluationSets/{evaluationSetsId}/operations/{operationsId}:wait", "id": "aiplatform.evaluationSets.operations.wait", "path": "v1beta1/{+name}:wait", "parameters": { "name": { "required": true, "description": "The name of the operation resource to wait on.", "type": "string", "location": "path", "pattern": "^evaluationSets/[^/]+/operations/[^/]+$" }, "timeout": { "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration", "location": "query" } }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" } }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "flatPath": "v1beta1/evaluationSets/{evaluationSetsId}/operations", "id": "aiplatform.evaluationSets.operations.list", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}/operations", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^evaluationSets/[^/]+$", "type": "string", "required": true, "location": "path" }, "pageSize": { "type": "integer", "description": "The standard list page size.", "format": "int32", "location": "query" }, "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." } }, "parameterOrder": [ "name" ] }, "delete": { "path": "v1beta1/{+name}", "parameters": { "name": { "required": true, "type": "string", "location": "path", "pattern": "^evaluationSets/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted." } }, "httpMethod": "DELETE", "id": "aiplatform.evaluationSets.operations.delete", "flatPath": "v1beta1/evaluationSets/{evaluationSetsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ] }, "get": { "flatPath": "v1beta1/evaluationSets/{evaluationSetsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^evaluationSets/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path", "description": "The name of the operation resource." } }, "id": "aiplatform.evaluationSets.operations.get", "path": "v1beta1/{+name}" } } } } }, "schedules": { "resources": { "operations": { "methods": { "wait": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "httpMethod": "POST", "parameterOrder": [ "name" ], "flatPath": "v1beta1/schedules/{schedulesId}/operations/{operationsId}:wait", "parameters": { "timeout": { "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "location": "query" }, "name": { "required": true, "type": "string", "pattern": "^schedules/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to wait on." } }, "path": "v1beta1/{+name}:wait", "id": "aiplatform.schedules.operations.wait" }, "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "pattern": "^schedules/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation resource to be cancelled.", "required": true } }, "id": "aiplatform.schedules.operations.cancel", "flatPath": "v1beta1/schedules/{schedulesId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ], "httpMethod": "POST", "path": "v1beta1/{+name}:cancel" }, "get": { "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "GET", "parameters": { "name": { "pattern": "^schedules/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation resource.", "required": true } }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/schedules/{schedulesId}/operations/{operationsId}", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.schedules.operations.get" }, "list": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/schedules/{schedulesId}/operations", "parameters": { "pageSize": { "type": "integer", "location": "query", "description": "The standard list page size.", "format": "int32" }, "name": { "location": "path", "pattern": "^schedules/[^/]+$", "type": "string", "required": true, "description": "The name of the operation's parent resource." }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" } }, "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "id": "aiplatform.schedules.operations.list", "path": "v1beta1/{+name}/operations", "parameterOrder": [ "name" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "delete": { "path": "v1beta1/{+name}", "httpMethod": "DELETE", "parameters": { "name": { "required": true, "type": "string", "location": "path", "pattern": "^schedules/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted." } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.schedules.operations.delete", "flatPath": "v1beta1/schedules/{schedulesId}/operations/{operationsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." } } } } }, "skills": { "resources": { "operations": { "methods": { "cancel": { "path": "v1beta1/{+name}:cancel", "flatPath": "v1beta1/skills/{skillsId}/operations/{operationsId}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "POST", "parameters": { "name": { "type": "string", "required": true, "description": "The name of the operation resource to be cancelled.", "pattern": "^skills/[^/]+/operations/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "aiplatform.skills.operations.cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." }, "list": { "path": "v1beta1/{+name}/operations", "parameters": { "name": { "required": true, "description": "The name of the operation's parent resource.", "location": "path", "type": "string", "pattern": "^skills/[^/]+$" }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "pageSize": { "description": "The standard list page size.", "type": "integer", "location": "query", "format": "int32" }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" } }, "httpMethod": "GET", "id": "aiplatform.skills.operations.list", "flatPath": "v1beta1/skills/{skillsId}/operations", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "delete": { "path": "v1beta1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "id": "aiplatform.skills.operations.delete", "flatPath": "v1beta1/skills/{skillsId}/operations/{operationsId}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^skills/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted." } }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." }, "get": { "parameterOrder": [ "name" ], "flatPath": "v1beta1/skills/{skillsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "pattern": "^skills/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "required": true, "description": "The name of the operation resource." } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "id": "aiplatform.skills.operations.get", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "GoogleLongrunningOperation" } }, "wait": { "id": "aiplatform.skills.operations.wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "timeout": { "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "type": "string" }, "name": { "type": "string", "required": true, "description": "The name of the operation resource to wait on.", "pattern": "^skills/[^/]+/operations/[^/]+$", "location": "path" } }, "httpMethod": "POST", "flatPath": "v1beta1/skills/{skillsId}/operations/{operationsId}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}:wait" } } } } }, "datasets": { "resources": { "dataItems": { "resources": { "annotations": { "resources": { "operations": { "methods": { "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "required": true, "pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+$", "location": "path", "type": "string" }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "pageSize": { "format": "int32", "description": "The standard list page size.", "type": "integer", "location": "query" }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." } }, "id": "aiplatform.datasets.dataItems.annotations.operations.list" }, "wait": { "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait", "parameterOrder": [ "name" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "id": "aiplatform.datasets.dataItems.annotations.operations.wait", "httpMethod": "POST", "parameters": { "name": { "pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", "type": "string", "required": true, "description": "The name of the operation resource to wait on.", "location": "path" }, "timeout": { "location": "query", "format": "google-duration", "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." } } }, "delete": { "flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}", "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to be deleted.", "location": "path", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.datasets.dataItems.annotations.operations.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." }, "get": { "id": "aiplatform.datasets.dataItems.annotations.operations.get", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "type": "string", "required": true, "description": "The name of the operation resource.", "pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$" } }, "httpMethod": "GET", "flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ] }, "cancel": { "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel", "path": "v1beta1/{+name}:cancel", "id": "aiplatform.datasets.dataItems.annotations.operations.cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameters": { "name": { "pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation resource to be cancelled.", "required": true } }, "httpMethod": "POST" } } } } }, "operations": { "methods": { "wait": { "id": "aiplatform.datasets.dataItems.operations.wait", "flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameters": { "name": { "location": "path", "pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", "required": true, "type": "string", "description": "The name of the operation resource to wait on." }, "timeout": { "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "format": "google-duration" } }, "httpMethod": "POST", "path": "v1beta1/{+name}:wait" }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.datasets.dataItems.operations.get", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the operation resource.", "type": "string", "pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", "location": "path", "required": true } }, "path": "v1beta1/{+name}", "httpMethod": "GET" }, "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "httpMethod": "DELETE", "path": "v1beta1/{+name}", "id": "aiplatform.datasets.dataItems.operations.delete" }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "aiplatform.datasets.dataItems.operations.list", "parameterOrder": [ "name" ], "flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations", "path": "v1beta1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameters": { "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "The standard list page size." }, "returnPartialSuccess": { "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "name": { "pattern": "^datasets/[^/]+/dataItems/[^/]+$", "type": "string", "description": "The name of the operation's parent resource.", "location": "path", "required": true }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "cancel": { "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "type": "string", "pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", "location": "path", "required": true } }, "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "POST", "id": "aiplatform.datasets.dataItems.operations.cancel", "flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel" } } } } }, "savedQueries": { "resources": { "operations": { "methods": { "cancel": { "path": "v1beta1/{+name}:cancel", "id": "aiplatform.datasets.savedQueries.operations.cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", "pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", "type": "string", "required": true } }, "flatPath": "v1beta1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ] }, "list": { "parameterOrder": [ "name" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations", "parameters": { "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "name": { "location": "path", "type": "string", "required": true, "pattern": "^datasets/[^/]+/savedQueries/[^/]+$", "description": "The name of the operation's parent resource." }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "location": "query", "description": "The standard list page size.", "format": "int32" }, "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." } }, "path": "v1beta1/{+name}/operations", "httpMethod": "GET", "id": "aiplatform.datasets.savedQueries.operations.list", "response": { "$ref": "GoogleLongrunningListOperationsResponse" } }, "wait": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "httpMethod": "POST", "parameters": { "timeout": { "type": "string", "format": "google-duration", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." }, "name": { "location": "path", "description": "The name of the operation resource to wait on.", "type": "string", "required": true, "pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$" } }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "flatPath": "v1beta1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait", "path": "v1beta1/{+name}:wait", "id": "aiplatform.datasets.savedQueries.operations.wait", "response": { "$ref": "GoogleLongrunningOperation" } }, "get": { "flatPath": "v1beta1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}", "parameters": { "name": { "description": "The name of the operation resource.", "type": "string", "required": true, "pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", "location": "path" } }, "httpMethod": "GET", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "id": "aiplatform.datasets.savedQueries.operations.get", "path": "v1beta1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "aiplatform.datasets.savedQueries.operations.delete", "path": "v1beta1/{+name}", "parameters": { "name": { "type": "string", "description": "The name of the operation resource to be deleted.", "required": true, "pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", "location": "path" } }, "httpMethod": "DELETE" } } } } }, "operations": { "methods": { "cancel": { "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/datasets/{datasetsId}/operations/{operationsId}:cancel", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", "pattern": "^datasets/[^/]+/operations/[^/]+$", "type": "string", "required": true } }, "httpMethod": "POST", "id": "aiplatform.datasets.operations.cancel", "path": "v1beta1/{+name}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "id": "aiplatform.datasets.operations.list", "parameters": { "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "name": { "required": true, "description": "The name of the operation's parent resource.", "location": "path", "type": "string", "pattern": "^datasets/[^/]+$" }, "pageSize": { "location": "query", "format": "int32", "description": "The standard list page size.", "type": "integer" }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." } }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1beta1/{+name}/operations", "flatPath": "v1beta1/datasets/{datasetsId}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" } }, "get": { "httpMethod": "GET", "parameters": { "name": { "location": "path", "pattern": "^datasets/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource.", "required": true } }, "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/datasets/{datasetsId}/operations/{operationsId}", "id": "aiplatform.datasets.operations.get", "path": "v1beta1/{+name}" }, "wait": { "path": "v1beta1/{+name}:wait", "flatPath": "v1beta1/datasets/{datasetsId}/operations/{operationsId}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "pattern": "^datasets/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to wait on.", "required": true, "location": "path", "type": "string" }, "timeout": { "location": "query", "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string" } }, "httpMethod": "POST", "id": "aiplatform.datasets.operations.wait" }, "delete": { "parameters": { "name": { "pattern": "^datasets/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to be deleted.", "location": "path", "type": "string" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE", "id": "aiplatform.datasets.operations.delete", "flatPath": "v1beta1/datasets/{datasetsId}/operations/{operationsId}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "datasetVersions": { "methods": { "list": { "response": { "$ref": "GoogleCloudAiplatformV1beta1ListDatasetVersionsResponse" }, "description": "Lists DatasetVersions in a Dataset.", "httpMethod": "GET", "id": "aiplatform.datasets.datasetVersions.list", "parameters": { "filter": { "location": "query", "type": "string", "description": "Optional. The standard list filter." }, "orderBy": { "type": "string", "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", "location": "query" }, "readMask": { "description": "Optional. Mask specifying which fields to read.", "format": "google-fieldmask", "location": "query", "type": "string" }, "parent": { "pattern": "^datasets/[^/]+$", "type": "string", "required": true, "location": "path", "description": "Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`" }, "pageSize": { "location": "query", "description": "Optional. The standard list page size.", "type": "integer", "format": "int32" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The standard list page token." } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/datasets/{datasetsId}/datasetVersions", "path": "v1beta1/{+parent}/datasetVersions", "parameterOrder": [ "parent" ] }, "create": { "description": "Create a version from a Dataset.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1DatasetVersion" }, "parameters": { "parent": { "required": true, "type": "string", "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", "location": "path", "pattern": "^datasets/[^/]+$" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.datasets.datasetVersions.create", "flatPath": "v1beta1/datasets/{datasetsId}/datasetVersions", "path": "v1beta1/{+parent}/datasetVersions" }, "restore": { "description": "Restores a dataset version.", "id": "aiplatform.datasets.datasetVersions.restore", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", "pattern": "^datasets/[^/]+/datasetVersions/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}:restore", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets a Dataset version.", "id": "aiplatform.datasets.datasetVersions.get", "response": { "$ref": "GoogleCloudAiplatformV1beta1DatasetVersion" }, "path": "v1beta1/{+name}", "parameters": { "readMask": { "format": "google-fieldmask", "location": "query", "description": "Mask specifying which fields to read.", "type": "string" }, "name": { "pattern": "^datasets/[^/]+/datasetVersions/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", "type": "string" } }, "flatPath": "v1beta1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", "httpMethod": "GET" }, "delete": { "flatPath": "v1beta1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "DELETE", "path": "v1beta1/{+name}", "parameters": { "name": { "type": "string", "pattern": "^datasets/[^/]+/datasetVersions/[^/]+$", "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", "location": "path", "required": true } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a Dataset version.", "id": "aiplatform.datasets.datasetVersions.delete" }, "patch": { "description": "Updates a DatasetVersion.", "parameterOrder": [ "name" ], "flatPath": "v1beta1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", "response": { "$ref": "GoogleCloudAiplatformV1beta1DatasetVersion" }, "httpMethod": "PATCH", "parameters": { "name": { "pattern": "^datasets/[^/]+/datasetVersions/[^/]+$", "location": "path", "type": "string", "description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", "required": true }, "updateMask": { "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name`", "format": "google-fieldmask", "type": "string", "location": "query" } }, "id": "aiplatform.datasets.datasetVersions.patch", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "request": { "$ref": "GoogleCloudAiplatformV1beta1DatasetVersion" } } } }, "annotationSpecs": { "resources": { "operations": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "parameters": { "name": { "pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", "type": "string", "location": "path", "description": "The name of the operation resource.", "required": true } }, "flatPath": "v1beta1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "id": "aiplatform.datasets.annotationSpecs.operations.get" }, "cancel": { "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel", "path": "v1beta1/{+name}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "id": "aiplatform.datasets.annotationSpecs.operations.cancel", "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation resource to be cancelled.", "location": "path", "pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$" } }, "httpMethod": "POST" }, "wait": { "httpMethod": "POST", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "path": "v1beta1/{+name}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "timeout": { "location": "query", "type": "string", "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." }, "name": { "location": "path", "pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource to wait on.", "required": true } }, "parameterOrder": [ "name" ], "id": "aiplatform.datasets.annotationSpecs.operations.wait", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait" }, "delete": { "id": "aiplatform.datasets.annotationSpecs.operations.delete", "path": "v1beta1/{+name}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "location": "path", "type": "string", "required": true, "pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$" } }, "flatPath": "v1beta1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "parameterOrder": [ "name" ] }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "httpMethod": "GET", "parameters": { "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "pageSize": { "format": "int32", "description": "The standard list page size.", "location": "query", "type": "integer" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "name": { "pattern": "^datasets/[^/]+/annotationSpecs/[^/]+$", "required": true, "description": "The name of the operation's parent resource.", "type": "string", "location": "path" } }, "flatPath": "v1beta1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations", "id": "aiplatform.datasets.annotationSpecs.operations.list", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1beta1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" } } } } } } }, "methods": { "create": { "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [], "path": "v1beta1/datasets", "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1Dataset" }, "parameters": { "parent": { "description": "Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}`", "location": "query", "type": "string" } }, "flatPath": "v1beta1/datasets", "id": "aiplatform.datasets.create", "description": "Creates a Dataset." }, "get": { "flatPath": "v1beta1/datasets/{datasetsId}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.datasets.get", "response": { "$ref": "GoogleCloudAiplatformV1beta1Dataset" }, "parameterOrder": [ "name" ], "parameters": { "readMask": { "location": "query", "description": "Mask specifying which fields to read.", "type": "string", "format": "google-fieldmask" }, "name": { "location": "path", "required": true, "description": "Required. The name of the Dataset resource.", "pattern": "^datasets/[^/]+$", "type": "string" } }, "path": "v1beta1/{+name}", "description": "Gets a Dataset.", "httpMethod": "GET" }, "list": { "flatPath": "v1beta1/datasets", "parameters": { "pageSize": { "format": "int32", "type": "integer", "location": "query", "description": "The standard list page size." }, "parent": { "location": "query", "description": "Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`", "type": "string" }, "readMask": { "location": "query", "format": "google-fieldmask", "type": "string", "description": "Mask specifying which fields to read." }, "orderBy": { "location": "query", "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time`", "type": "string" }, "filter": { "type": "string", "location": "query", "description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"`" }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" } }, "path": "v1beta1/datasets", "httpMethod": "GET", "id": "aiplatform.datasets.list", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1ListDatasetsResponse" }, "parameterOrder": [], "description": "Lists Datasets in a Location." }, "patch": { "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudAiplatformV1beta1Dataset" }, "parameters": { "name": { "description": "Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", "pattern": "^datasets/[^/]+$", "required": true, "type": "string", "location": "path" }, "updateMask": { "format": "google-fieldmask", "location": "query", "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels`", "type": "string" } }, "flatPath": "v1beta1/datasets/{datasetsId}", "id": "aiplatform.datasets.patch", "request": { "$ref": "GoogleCloudAiplatformV1beta1Dataset" }, "parameterOrder": [ "name" ], "description": "Updates a Dataset.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}" }, "delete": { "description": "Deletes a Dataset.", "parameterOrder": [ "name" ], "flatPath": "v1beta1/datasets/{datasetsId}", "httpMethod": "DELETE", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.datasets.delete", "parameters": { "name": { "pattern": "^datasets/[^/]+$", "type": "string", "required": true, "description": "Required. The resource name of the Dataset to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}" } } }, "tensorboards": { "resources": { "experiments": { "resources": { "operations": { "methods": { "wait": { "parameterOrder": [ "name" ], "httpMethod": "POST", "id": "aiplatform.tensorboards.experiments.operations.wait", "parameters": { "name": { "location": "path", "type": "string", "required": true, "description": "The name of the operation resource to wait on.", "pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$" }, "timeout": { "location": "query", "type": "string", "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." } }, "path": "v1beta1/{+name}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done." }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "httpMethod": "DELETE", "id": "aiplatform.tensorboards.experiments.operations.delete", "parameters": { "name": { "pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to be deleted.", "location": "path", "type": "string" } } }, "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "id": "aiplatform.tensorboards.experiments.operations.list", "path": "v1beta1/{+name}/operations", "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "httpMethod": "GET", "parameters": { "name": { "pattern": "^tensorboards/[^/]+/experiments/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation's parent resource.", "required": true }, "pageSize": { "description": "The standard list page size.", "type": "integer", "location": "query", "format": "int32" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." } } }, "get": { "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", "path": "v1beta1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "type": "string", "required": true, "description": "The name of the operation resource.", "pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$" } }, "parameterOrder": [ "name" ], "id": "aiplatform.tensorboards.experiments.operations.get" }, "cancel": { "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be cancelled.", "required": true } }, "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel", "id": "aiplatform.tensorboards.experiments.operations.cancel", "httpMethod": "POST", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "path": "v1beta1/{+name}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } } }, "runs": { "resources": { "operations": { "methods": { "delete": { "parameterOrder": [ "name" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.tensorboards.experiments.runs.operations.delete", "parameters": { "name": { "required": true, "type": "string", "location": "path", "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted." } }, "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", "httpMethod": "DELETE" }, "get": { "id": "aiplatform.tensorboards.experiments.runs.operations.get", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameters": { "name": { "location": "path", "description": "The name of the operation resource.", "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", "type": "string", "required": true } }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ] }, "wait": { "path": "v1beta1/{+name}:wait", "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.tensorboards.experiments.runs.operations.wait", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "httpMethod": "POST", "parameters": { "name": { "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", "location": "path", "required": true, "description": "The name of the operation resource to wait on.", "type": "string" }, "timeout": { "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "format": "google-duration" } } }, "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "path": "v1beta1/{+name}:cancel", "id": "aiplatform.tensorboards.experiments.runs.operations.cancel", "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", "type": "string", "required": true, "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$" } }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "list": { "path": "v1beta1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations", "parameters": { "pageSize": { "description": "The standard list page size.", "type": "integer", "location": "query", "format": "int32" }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "name": { "description": "The name of the operation's parent resource.", "location": "path", "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" } }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "httpMethod": "GET", "id": "aiplatform.tensorboards.experiments.runs.operations.list", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } } }, "timeSeries": { "resources": { "operations": { "methods": { "cancel": { "httpMethod": "POST", "parameters": { "name": { "location": "path", "description": "The name of the operation resource to be cancelled.", "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel", "id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.cancel" }, "list": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}/operations", "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameters": { "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "pageSize": { "type": "integer", "description": "The standard list page size.", "format": "int32", "location": "query" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "name": { "required": true, "type": "string", "description": "The name of the operation's parent resource.", "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", "location": "path" }, "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." } }, "id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.list", "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE", "parameters": { "name": { "type": "string", "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be deleted.", "required": true } }, "id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.delete", "parameterOrder": [ "name" ], "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}" }, "get": { "httpMethod": "GET", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "path": "v1beta1/{+name}", "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", "description": "The name of the operation resource." } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.get" }, "wait": { "id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to wait on.", "location": "path", "type": "string" }, "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "type": "string", "format": "google-duration" } }, "path": "v1beta1/{+name}:wait", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait", "parameterOrder": [ "name" ] } } } } } } } } }, "operations": { "methods": { "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/tensorboards/{tensorboardsId}/operations/{operationsId}", "httpMethod": "DELETE", "id": "aiplatform.tensorboards.operations.delete", "parameters": { "name": { "pattern": "^tensorboards/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "required": true, "type": "string", "location": "path" } }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." }, "list": { "id": "aiplatform.tensorboards.operations.list", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1beta1/{+name}/operations", "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameters": { "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "The standard list page size." }, "name": { "pattern": "^tensorboards/[^/]+$", "required": true, "type": "string", "location": "path", "description": "The name of the operation's parent resource." }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" } }, "flatPath": "v1beta1/tensorboards/{tensorboardsId}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "wait": { "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:wait", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "timeout": { "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "format": "google-duration" }, "name": { "required": true, "pattern": "^tensorboards/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation resource to wait on." } }, "flatPath": "v1beta1/tensorboards/{tensorboardsId}/operations/{operationsId}:wait", "id": "aiplatform.tensorboards.operations.wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "response": { "$ref": "GoogleLongrunningOperation" } }, "get": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/tensorboards/{tensorboardsId}/operations/{operationsId}", "parameters": { "name": { "description": "The name of the operation resource.", "required": true, "type": "string", "location": "path", "pattern": "^tensorboards/[^/]+/operations/[^/]+$" } }, "id": "aiplatform.tensorboards.operations.get", "path": "v1beta1/{+name}", "httpMethod": "GET", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ] }, "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "path": "v1beta1/{+name}:cancel", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "required": true, "pattern": "^tensorboards/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource to be cancelled." } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.tensorboards.operations.cancel", "flatPath": "v1beta1/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "response": { "$ref": "GoogleProtobufEmpty" } } } } } }, "agents": { "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "path": "v1beta1/{+name}:cancel", "id": "aiplatform.agents.operations.cancel", "parameters": { "name": { "type": "string", "location": "path", "pattern": "^agents/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to be cancelled." } }, "parameterOrder": [ "name" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/agents/{agentsId}/operations/{operationsId}:cancel", "response": { "$ref": "GoogleProtobufEmpty" } }, "get": { "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.agents.operations.get", "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "GET", "flatPath": "v1beta1/agents/{agentsId}/operations/{operationsId}", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^agents/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "required": true } } }, "list": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "description": "The standard list page size.", "format": "int32", "location": "query" }, "name": { "type": "string", "pattern": "^agents/[^/]+$", "location": "path", "description": "The name of the operation's parent resource.", "required": true }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } }, "id": "aiplatform.agents.operations.list", "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "flatPath": "v1beta1/agents/{agentsId}/operations", "path": "v1beta1/{+name}/operations" }, "wait": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:wait", "parameterOrder": [ "name" ], "httpMethod": "POST", "parameters": { "name": { "required": true, "type": "string", "pattern": "^agents/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to wait on." }, "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "format": "google-duration", "type": "string" } }, "flatPath": "v1beta1/agents/{agentsId}/operations/{operationsId}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "id": "aiplatform.agents.operations.wait" }, "delete": { "parameterOrder": [ "name" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "path": "v1beta1/{+name}", "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^agents/[^/]+/operations/[^/]+$", "type": "string", "required": true, "description": "The name of the operation resource to be deleted.", "location": "path" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/agents/{agentsId}/operations/{operationsId}", "id": "aiplatform.agents.operations.delete" } } } } }, "solvers": { "resources": { "operations": { "methods": { "get": { "flatPath": "v1beta1/solvers/{solversId}/operations/{operationsId}", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation resource.", "location": "path", "pattern": "^solvers/[^/]+/operations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.solvers.operations.get" }, "list": { "flatPath": "v1beta1/solvers/{solversId}/operations", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^solvers/[^/]+$", "required": true, "type": "string", "location": "path" }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "pageSize": { "location": "query", "description": "The standard list page size.", "format": "int32", "type": "integer" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" } }, "id": "aiplatform.solvers.operations.list", "parameterOrder": [ "name" ], "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1beta1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "aiplatform.solvers.operations.delete", "path": "v1beta1/{+name}", "parameters": { "name": { "location": "path", "type": "string", "required": true, "description": "The name of the operation resource to be deleted.", "pattern": "^solvers/[^/]+/operations/[^/]+$" } }, "httpMethod": "DELETE", "flatPath": "v1beta1/solvers/{solversId}/operations/{operationsId}" } } } } }, "onlineEvaluators": { "resources": { "operations": { "methods": { "cancel": { "parameterOrder": [ "name" ], "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:cancel", "path": "v1beta1/{+name}:cancel", "id": "aiplatform.onlineEvaluators.operations.cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "response": { "$ref": "GoogleProtobufEmpty" } }, "wait": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.onlineEvaluators.operations.wait", "flatPath": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:wait", "httpMethod": "POST", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to wait on.", "required": true, "location": "path", "type": "string" }, "timeout": { "type": "string", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration" } }, "path": "v1beta1/{+name}:wait" }, "get": { "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "The name of the operation resource.", "location": "path", "required": true, "pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", "type": "string" } }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "id": "aiplatform.onlineEvaluators.operations.get" }, "list": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "returnPartialSuccess": { "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query" }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" }, "pageSize": { "location": "query", "description": "The standard list page size.", "type": "integer", "format": "int32" }, "name": { "pattern": "^onlineEvaluators/[^/]+$", "description": "The name of the operation's parent resource.", "location": "path", "required": true, "type": "string" } }, "httpMethod": "GET", "path": "v1beta1/{+name}/operations", "parameterOrder": [ "name" ], "id": "aiplatform.onlineEvaluators.operations.list", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "flatPath": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations" }, "delete": { "id": "aiplatform.onlineEvaluators.operations.delete", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "httpMethod": "DELETE", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "required": true, "pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be deleted.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}" } } } } }, "notebookExecutionJobs": { "resources": { "operations": { "methods": { "get": { "id": "aiplatform.notebookExecutionJobs.operations.get", "httpMethod": "GET", "path": "v1beta1/{+name}", "parameters": { "name": { "description": "The name of the operation resource.", "type": "string", "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", "required": true, "location": "path" } }, "flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "GoogleLongrunningOperation" } }, "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}:cancel", "flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ], "id": "aiplatform.notebookExecutionJobs.operations.cancel", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path" } }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.notebookExecutionJobs.operations.delete", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted." } }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}" }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameterOrder": [ "name" ], "parameters": { "timeout": { "type": "string", "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query" }, "name": { "type": "string", "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to wait on.", "required": true, "location": "path" } }, "flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait", "path": "v1beta1/{+name}:wait", "httpMethod": "POST", "id": "aiplatform.notebookExecutionJobs.operations.wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "id": "aiplatform.notebookExecutionJobs.operations.list", "httpMethod": "GET", "path": "v1beta1/{+name}/operations", "parameters": { "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "pageSize": { "description": "The standard list page size.", "format": "int32", "type": "integer", "location": "query" }, "name": { "location": "path", "type": "string", "pattern": "^notebookExecutionJobs/[^/]+$", "required": true, "description": "The name of the operation's parent resource." }, "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" } }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations" } } } } }, "featureOnlineStores": { "resources": { "operations": { "methods": { "wait": { "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait", "path": "v1beta1/{+name}:wait", "parameters": { "name": { "pattern": "^featureOnlineStores/[^/]+/operations/[^/]+$", "type": "string", "required": true, "description": "The name of the operation resource to wait on.", "location": "path" }, "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "format": "google-duration", "type": "string" } }, "httpMethod": "POST", "id": "aiplatform.featureOnlineStores.operations.wait", "parameterOrder": [ "name" ] }, "get": { "flatPath": "v1beta1/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "type": "string", "description": "The name of the operation resource.", "pattern": "^featureOnlineStores/[^/]+/operations/[^/]+$", "required": true, "location": "path" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.featureOnlineStores.operations.get", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "id": "aiplatform.featureOnlineStores.operations.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "pattern": "^featureOnlineStores/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to be deleted.", "type": "string", "location": "path" } }, "path": "v1beta1/{+name}", "flatPath": "v1beta1/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE" }, "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1beta1/{+name}/operations", "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameters": { "pageSize": { "description": "The standard list page size.", "format": "int32", "type": "integer", "location": "query" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" }, "name": { "description": "The name of the operation's parent resource.", "type": "string", "pattern": "^featureOnlineStores/[^/]+$", "required": true, "location": "path" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" } }, "flatPath": "v1beta1/featureOnlineStores/{featureOnlineStoresId}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "aiplatform.featureOnlineStores.operations.list" } } }, "featureViews": { "resources": { "operations": { "methods": { "delete": { "id": "aiplatform.featureOnlineStores.featureViews.operations.delete", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "flatPath": "v1beta1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}", "httpMethod": "DELETE", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "required": true, "location": "path" } } }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path", "description": "The name of the operation resource." } }, "id": "aiplatform.featureOnlineStores.featureViews.operations.get" }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "flatPath": "v1beta1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.featureOnlineStores.featureViews.operations.wait", "path": "v1beta1/{+name}:wait", "parameters": { "timeout": { "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "format": "google-duration" }, "name": { "pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to wait on.", "required": true, "type": "string" } }, "httpMethod": "POST" }, "list": { "flatPath": "v1beta1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations", "httpMethod": "GET", "parameters": { "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "The standard list page size." }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "name": { "required": true, "type": "string", "description": "The name of the operation's parent resource.", "location": "path", "pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+$" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" } }, "path": "v1beta1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.featureOnlineStores.featureViews.operations.list", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ] } } } } } } }, "memoryBanks": { "resources": { "memories": { "methods": { "patch": { "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "pattern": "^memoryBanks/[^/]+/memories/[^/]+$", "description": "Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", "type": "string", "required": true }, "updateMask": { "type": "string", "format": "google-fieldmask", "location": "query", "description": "Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type`" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "request": { "$ref": "GoogleCloudAiplatformV1beta1Memory" }, "parameterOrder": [ "name" ], "description": "Update a Memory.", "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}", "id": "aiplatform.memoryBanks.memories.patch", "path": "v1beta1/{+name}" }, "delete": { "httpMethod": "DELETE", "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}", "parameters": { "name": { "type": "string", "description": "Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", "pattern": "^memoryBanks/[^/]+/memories/[^/]+$", "required": true } }, "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Delete a Memory.", "id": "aiplatform.memoryBanks.memories.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "create": { "parameters": { "memoryId": { "location": "query", "description": "Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number.", "type": "string" }, "parent": { "description": "Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "pattern": "^memoryBanks/[^/]+$", "required": true, "type": "string", "location": "path" } }, "httpMethod": "POST", "path": "v1beta1/{+parent}/memories", "id": "aiplatform.memoryBanks.memories.create", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories", "request": { "$ref": "GoogleCloudAiplatformV1beta1Memory" }, "description": "Create a Memory." }, "retrieveProfiles": { "path": "v1beta1/{+parent}/memories:retrieveProfiles", "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories:retrieveProfiles", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1RetrieveProfilesRequest" }, "id": "aiplatform.memoryBanks.memories.retrieveProfiles", "description": "Retrieves profiles.", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "required": true, "type": "string", "pattern": "^memoryBanks/[^/]+$", "location": "path", "description": "Required. The resource name of the ReasoningEngine to retrieve profiles from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1RetrieveProfilesResponse" } }, "get": { "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "pattern": "^memoryBanks/[^/]+/memories/[^/]+$", "required": true, "type": "string", "location": "path" } }, "id": "aiplatform.memoryBanks.memories.get", "response": { "$ref": "GoogleCloudAiplatformV1beta1Memory" }, "description": "Get a Memory.", "httpMethod": "GET" }, "rollback": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "type": "string", "description": "Required. The resource name of the Memory to rollback. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", "pattern": "^memoryBanks/[^/]+/memories/[^/]+$" } }, "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}:rollback", "description": "Rollback Memory to a specific revision.", "request": { "$ref": "GoogleCloudAiplatformV1beta1RollbackMemoryRequest" }, "id": "aiplatform.memoryBanks.memories.rollback", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}:rollback" }, "retrieve": { "parameters": { "parent": { "type": "string", "pattern": "^memoryBanks/[^/]+$", "location": "path", "description": "Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true } }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequest" }, "id": "aiplatform.memoryBanks.memories.retrieve", "path": "v1beta1/{+parent}/memories:retrieve", "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories:retrieve", "response": { "$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Retrieve memories." }, "purge": { "parameters": { "parent": { "type": "string", "location": "path", "pattern": "^memoryBanks/[^/]+$", "description": "Required. The resource name of the ReasoningEngine to purge memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true } }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1PurgeMemoriesRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+parent}/memories:purge", "description": "Purge memories.", "id": "aiplatform.memoryBanks.memories.purge", "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories:purge" }, "generate": { "id": "aiplatform.memoryBanks.memories.generate", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+parent}/memories:generate", "description": "Generate memories.", "parameters": { "parent": { "location": "path", "description": "Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true, "type": "string", "pattern": "^memoryBanks/[^/]+$" } }, "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories:generate", "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequest" } }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "id": "aiplatform.memoryBanks.memories.list", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListMemoriesResponse" }, "httpMethod": "GET", "parameters": { "parent": { "pattern": "^memoryBanks/[^/]+$", "required": true, "type": "string", "description": "Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path" }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "Optional. The standard list page size." }, "orderBy": { "location": "query", "description": "Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`", "type": "string" }, "filter": { "type": "string", "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `scope` (as a JSON string with equality match only) * `topics` (i.e. `topics.custom_memory_topic_label: \"example topic\" OR topics.managed_memory_topic: USER_PREFERENCES`)", "location": "query" }, "pageToken": { "location": "query", "description": "Optional. The standard list page token.", "type": "string" } }, "path": "v1beta1/{+parent}/memories", "description": "List Memories.", "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories" } }, "resources": { "operations": { "methods": { "cancel": { "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:cancel", "id": "aiplatform.memoryBanks.memories.operations.cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "path": "v1beta1/{+name}:cancel", "parameters": { "name": { "location": "path", "pattern": "^memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "type": "string", "required": true, "description": "The name of the operation resource to be cancelled." } } }, "get": { "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "id": "aiplatform.memoryBanks.memories.operations.get", "httpMethod": "GET", "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", "parameters": { "name": { "type": "string", "location": "path", "description": "The name of the operation resource.", "required": true, "pattern": "^memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$" } }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" } }, "wait": { "id": "aiplatform.memoryBanks.memories.operations.wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "type": "string", "pattern": "^memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to wait on." }, "timeout": { "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "format": "google-duration" } }, "path": "v1beta1/{+name}:wait", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:wait", "parameterOrder": [ "name" ] }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation resource to be deleted.", "required": true } }, "httpMethod": "DELETE", "id": "aiplatform.memoryBanks.memories.operations.delete", "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." }, "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameterOrder": [ "name" ], "id": "aiplatform.memoryBanks.memories.operations.list", "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^memoryBanks/[^/]+/memories/[^/]+$", "location": "path", "description": "The name of the operation's parent resource.", "type": "string", "required": true }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "The standard list page size." } }, "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v1beta1/{+name}/operations" } } }, "revisions": { "methods": { "get": { "parameters": { "name": { "location": "path", "description": "Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{revision}`", "required": true, "pattern": "^memoryBanks/[^/]+/memories/[^/]+/revisions/[^/]+$", "type": "string" } }, "httpMethod": "GET", "id": "aiplatform.memoryBanks.memories.revisions.get", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleCloudAiplatformV1beta1MemoryRevision" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get a Memory Revision.", "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/revisions/{revisionsId}" }, "list": { "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/revisions", "parameters": { "pageSize": { "format": "int32", "type": "integer", "location": "query", "description": "Optional. The standard list page size." }, "pageToken": { "type": "string", "location": "query", "description": "Optional. The standard list page token." }, "parent": { "description": "Required. The resource name of the Memory to list revisions for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "required": true, "pattern": "^memoryBanks/[^/]+/memories/[^/]+$", "type": "string", "location": "path" }, "filter": { "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels`", "type": "string", "location": "query" } }, "path": "v1beta1/{+parent}/revisions", "httpMethod": "GET", "description": "List Memory Revisions for a Memory.", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListMemoryRevisionsResponse" }, "id": "aiplatform.memoryBanks.memories.revisions.list", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } }, "operations": { "methods": { "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/operations", "httpMethod": "GET", "path": "v1beta1/{+name}/operations", "id": "aiplatform.memoryBanks.operations.list", "parameters": { "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "name": { "required": true, "location": "path", "pattern": "^memoryBanks/[^/]+$", "type": "string", "description": "The name of the operation's parent resource." }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "pageSize": { "type": "integer", "format": "int32", "description": "The standard list page size.", "location": "query" }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" } }, "parameterOrder": [ "name" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "cancel": { "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/operations/{operationsId}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameterOrder": [ "name" ], "id": "aiplatform.memoryBanks.operations.cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:cancel", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^memoryBanks/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path" } }, "httpMethod": "POST" }, "wait": { "httpMethod": "POST", "parameterOrder": [ "name" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameters": { "timeout": { "format": "google-duration", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string" }, "name": { "pattern": "^memoryBanks/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation resource to wait on.", "required": true } }, "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/operations/{operationsId}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.memoryBanks.operations.wait" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "type": "string", "required": true, "description": "The name of the operation resource to be deleted.", "pattern": "^memoryBanks/[^/]+/operations/[^/]+$" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.memoryBanks.operations.delete", "httpMethod": "DELETE", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/operations/{operationsId}" }, "get": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "id": "aiplatform.memoryBanks.operations.get", "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/operations/{operationsId}", "path": "v1beta1/{+name}", "parameters": { "name": { "pattern": "^memoryBanks/[^/]+/operations/[^/]+$", "description": "The name of the operation resource.", "location": "path", "type": "string", "required": true } }, "httpMethod": "GET", "parameterOrder": [ "name" ] } } } }, "methods": { "ingestEvents": { "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+parent}:ingestEvents", "flatPath": "v1beta1/memoryBanks/{memoryBanksId}:ingestEvents", "description": "Ingests events for a Memory Bank.", "parameterOrder": [ "parent" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.memoryBanks.ingestEvents", "parameters": { "parent": { "location": "path", "description": "Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true, "pattern": "^memoryBanks/[^/]+$", "type": "string" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1IngestEventsRequest" } } } }, "models": { "resources": { "operations": { "methods": { "cancel": { "parameters": { "name": { "type": "string", "pattern": "^models/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be cancelled.", "location": "path", "required": true } }, "flatPath": "v1beta1/models/{modelsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:cancel", "parameterOrder": [ "name" ], "id": "aiplatform.models.operations.cancel" }, "list": { "id": "aiplatform.models.operations.list", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameterOrder": [ "name" ], "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "flatPath": "v1beta1/models/{modelsId}/operations", "parameters": { "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "name": { "location": "path", "type": "string", "description": "The name of the operation's parent resource.", "required": true, "pattern": "^models/[^/]+$" }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "pageSize": { "type": "integer", "format": "int32", "description": "The standard list page size.", "location": "query" } }, "path": "v1beta1/{+name}/operations" }, "delete": { "flatPath": "v1beta1/models/{modelsId}/operations/{operationsId}", "path": "v1beta1/{+name}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameters": { "name": { "type": "string", "description": "The name of the operation resource to be deleted.", "required": true, "pattern": "^models/[^/]+/operations/[^/]+$", "location": "path" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.models.operations.delete", "parameterOrder": [ "name" ] }, "get": { "httpMethod": "GET", "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation resource.", "location": "path", "pattern": "^models/[^/]+/operations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.models.operations.get", "parameterOrder": [ "name" ], "flatPath": "v1beta1/models/{modelsId}/operations/{operationsId}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "path": "v1beta1/{+name}" }, "wait": { "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "format": "google-duration", "type": "string" }, "name": { "type": "string", "description": "The name of the operation resource to wait on.", "pattern": "^models/[^/]+/operations/[^/]+$", "required": true, "location": "path" } }, "parameterOrder": [ "name" ], "httpMethod": "POST", "id": "aiplatform.models.operations.wait", "path": "v1beta1/{+name}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/models/{modelsId}/operations/{operationsId}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done." } } }, "evaluations": { "resources": { "operations": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.models.evaluations.operations.get", "parameters": { "name": { "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource.", "required": true, "type": "string" } }, "httpMethod": "GET", "flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}" }, "cancel": { "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", "required": true, "location": "path", "type": "string" } }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "id": "aiplatform.models.evaluations.operations.cancel", "flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:cancel" }, "wait": { "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.models.evaluations.operations.wait", "flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait", "path": "v1beta1/{+name}:wait", "httpMethod": "POST", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameters": { "timeout": { "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "location": "query" }, "name": { "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to wait on.", "required": true, "type": "string", "location": "path" } } }, "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "location": "path", "type": "string", "required": true, "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$" } }, "id": "aiplatform.models.evaluations.operations.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." }, "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^models/[^/]+/evaluations/[^/]+$", "type": "string", "required": true, "location": "path" }, "pageSize": { "location": "query", "description": "The standard list page size.", "type": "integer", "format": "int32" }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." } }, "flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations", "httpMethod": "GET", "id": "aiplatform.models.evaluations.operations.list", "path": "v1beta1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." } } } } } } }, "evaluationItems": { "resources": { "operations": { "methods": { "list": { "id": "aiplatform.evaluationItems.operations.list", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "format": "int32", "description": "The standard list page size.", "type": "integer", "location": "query" }, "returnPartialSuccess": { "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query" }, "name": { "pattern": "^evaluationItems/[^/]+$", "description": "The name of the operation's parent resource.", "location": "path", "type": "string", "required": true }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" } }, "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1beta1/{+name}/operations", "httpMethod": "GET", "flatPath": "v1beta1/evaluationItems/{evaluationItemsId}/operations", "parameterOrder": [ "name" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "flatPath": "v1beta1/evaluationItems/{evaluationItemsId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.evaluationItems.operations.get", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^evaluationItems/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET" }, "wait": { "httpMethod": "POST", "path": "v1beta1/{+name}:wait", "parameters": { "name": { "location": "path", "pattern": "^evaluationItems/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to wait on.", "type": "string" }, "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "format": "google-duration", "location": "query" } }, "parameterOrder": [ "name" ], "id": "aiplatform.evaluationItems.operations.wait", "flatPath": "v1beta1/evaluationItems/{evaluationItemsId}/operations/{operationsId}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "httpMethod": "DELETE", "parameters": { "name": { "required": true, "description": "The name of the operation resource to be deleted.", "type": "string", "pattern": "^evaluationItems/[^/]+/operations/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "aiplatform.evaluationItems.operations.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/evaluationItems/{evaluationItemsId}/operations/{operationsId}", "path": "v1beta1/{+name}" } } } } }, "ragEngineConfig": { "resources": { "operations": { "methods": { "delete": { "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "pattern": "^ragEngineConfig/operations/[^/]+$", "required": true, "type": "string", "location": "path" } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}", "id": "aiplatform.ragEngineConfig.operations.delete", "flatPath": "v1beta1/ragEngineConfig/operations/{operationsId}" }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v1beta1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "httpMethod": "GET", "flatPath": "v1beta1/ragEngineConfig/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.ragEngineConfig.operations.list", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the operation's parent resource.", "location": "path", "type": "string", "required": true, "pattern": "^ragEngineConfig$" }, "pageSize": { "description": "The standard list page size.", "location": "query", "format": "int32", "type": "integer" }, "returnPartialSuccess": { "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." } } }, "get": { "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "location": "path", "description": "The name of the operation resource.", "type": "string", "pattern": "^ragEngineConfig/operations/[^/]+$", "required": true } }, "id": "aiplatform.ragEngineConfig.operations.get", "httpMethod": "GET", "path": "v1beta1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/ragEngineConfig/operations/{operationsId}" }, "wait": { "httpMethod": "POST", "parameters": { "name": { "type": "string", "pattern": "^ragEngineConfig/operations/[^/]+$", "required": true, "location": "path", "description": "The name of the operation resource to wait on." }, "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "location": "query", "format": "google-duration" } }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "id": "aiplatform.ragEngineConfig.operations.wait", "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/ragEngineConfig/operations/{operationsId}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "cancel": { "flatPath": "v1beta1/ragEngineConfig/operations/{operationsId}:cancel", "parameters": { "name": { "location": "path", "type": "string", "pattern": "^ragEngineConfig/operations/[^/]+$", "required": true, "description": "The name of the operation resource to be cancelled." } }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.ragEngineConfig.operations.cancel", "path": "v1beta1/{+name}:cancel", "parameterOrder": [ "name" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." } } } } }, "tuningJobs": { "resources": { "operations": { "methods": { "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}", "flatPath": "v1beta1/tuningJobs/{tuningJobsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "aiplatform.tuningJobs.operations.delete", "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^tuningJobs/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to be deleted.", "type": "string", "location": "path" } } }, "get": { "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "description": "The name of the operation resource.", "location": "path", "type": "string", "pattern": "^tuningJobs/[^/]+/operations/[^/]+$" } }, "flatPath": "v1beta1/tuningJobs/{tuningJobsId}/operations/{operationsId}", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.tuningJobs.operations.get", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "path": "v1beta1/{+name}:wait", "parameterOrder": [ "name" ], "parameters": { "timeout": { "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "location": "query" }, "name": { "pattern": "^tuningJobs/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "required": true, "description": "The name of the operation resource to wait on." } }, "httpMethod": "POST", "id": "aiplatform.tuningJobs.operations.wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/tuningJobs/{tuningJobsId}/operations/{operationsId}:wait" }, "cancel": { "flatPath": "v1beta1/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}:cancel", "parameterOrder": [ "name" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^tuningJobs/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "required": true } }, "id": "aiplatform.tuningJobs.operations.cancel", "httpMethod": "POST" } } } } }, "trainingPipelines": { "resources": { "operations": { "methods": { "cancel": { "httpMethod": "POST", "id": "aiplatform.trainingPipelines.operations.cancel", "path": "v1beta1/{+name}:cancel", "parameters": { "name": { "location": "path", "description": "The name of the operation resource to be cancelled.", "type": "string", "required": true, "pattern": "^trainingPipelines/[^/]+/operations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1beta1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ] }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^trainingPipelines/[^/]+/operations/[^/]+$", "required": true, "location": "path", "type": "string" } }, "id": "aiplatform.trainingPipelines.operations.get", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}" }, "list": { "id": "aiplatform.trainingPipelines.operations.list", "flatPath": "v1beta1/trainingPipelines/{trainingPipelinesId}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1beta1/{+name}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "name": { "required": true, "description": "The name of the operation's parent resource.", "pattern": "^trainingPipelines/[^/]+$", "type": "string", "location": "path" }, "pageSize": { "location": "query", "type": "integer", "description": "The standard list page size.", "format": "int32" }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" } }, "httpMethod": "GET" }, "wait": { "httpMethod": "POST", "path": "v1beta1/{+name}:wait", "parameters": { "timeout": { "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "location": "query" }, "name": { "type": "string", "pattern": "^trainingPipelines/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to wait on.", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait", "id": "aiplatform.trainingPipelines.operations.wait", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done." }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "aiplatform.trainingPipelines.operations.delete", "httpMethod": "DELETE", "path": "v1beta1/{+name}", "parameters": { "name": { "type": "string", "description": "The name of the operation resource to be deleted.", "location": "path", "pattern": "^trainingPipelines/[^/]+/operations/[^/]+$", "required": true } }, "parameterOrder": [ "name" ] } } } } }, "indexEndpoints": { "resources": { "operations": { "methods": { "cancel": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel", "parameters": { "name": { "pattern": "^indexEndpoints/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "required": true, "description": "The name of the operation resource to be cancelled." } }, "path": "v1beta1/{+name}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.indexEndpoints.operations.cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameterOrder": [ "name" ] }, "list": { "parameters": { "name": { "description": "The name of the operation's parent resource.", "location": "path", "pattern": "^indexEndpoints/[^/]+$", "required": true, "type": "string" }, "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "pageSize": { "format": "int32", "type": "integer", "location": "query", "description": "The standard list page size." }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" } }, "httpMethod": "GET", "flatPath": "v1beta1/indexEndpoints/{indexEndpointsId}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "id": "aiplatform.indexEndpoints.operations.list", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "wait": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait", "id": "aiplatform.indexEndpoints.operations.wait", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:wait", "parameters": { "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration", "location": "query", "type": "string" }, "name": { "required": true, "description": "The name of the operation resource to wait on.", "location": "path", "pattern": "^indexEndpoints/[^/]+/operations/[^/]+$", "type": "string" } }, "httpMethod": "POST" }, "get": { "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "location": "path", "required": true, "pattern": "^indexEndpoints/[^/]+/operations/[^/]+$", "description": "The name of the operation resource.", "type": "string" } }, "path": "v1beta1/{+name}", "id": "aiplatform.indexEndpoints.operations.get", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ] }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "flatPath": "v1beta1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.indexEndpoints.operations.delete", "path": "v1beta1/{+name}", "httpMethod": "DELETE", "parameters": { "name": { "type": "string", "required": true, "description": "The name of the operation resource to be deleted.", "location": "path", "pattern": "^indexEndpoints/[^/]+/operations/[^/]+$" } } } } } } }, "persistentResources": { "resources": { "operations": { "methods": { "wait": { "path": "v1beta1/{+name}:wait", "flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.persistentResources.operations.wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameters": { "timeout": { "format": "google-duration", "location": "query", "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." }, "name": { "pattern": "^persistentResources/[^/]+/operations/[^/]+$", "type": "string", "location": "path", "description": "The name of the operation resource to wait on.", "required": true } }, "parameterOrder": [ "name" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "cancel": { "httpMethod": "POST", "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^persistentResources/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be cancelled." } }, "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.persistentResources.operations.cancel", "flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." }, "get": { "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameters": { "name": { "type": "string", "required": true, "pattern": "^persistentResources/[^/]+/operations/[^/]+$", "description": "The name of the operation resource.", "location": "path" } }, "id": "aiplatform.persistentResources.operations.get", "httpMethod": "GET", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}" }, "list": { "path": "v1beta1/{+name}/operations", "id": "aiplatform.persistentResources.operations.list", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameters": { "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "name": { "pattern": "^persistentResources/[^/]+$", "description": "The name of the operation's parent resource.", "required": true, "location": "path", "type": "string" }, "pageSize": { "format": "int32", "location": "query", "description": "The standard list page size.", "type": "integer" }, "returnPartialSuccess": { "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" } }, "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations" }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}", "path": "v1beta1/{+name}", "id": "aiplatform.persistentResources.operations.delete", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "required": true, "pattern": "^persistentResources/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource to be deleted.", "location": "path" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } }, "extensionControllers": { "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "id": "aiplatform.extensionControllers.operations.cancel", "parameterOrder": [ "name" ], "flatPath": "v1beta1/extensionControllers/{extensionControllersId}/operations/{operationsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}:cancel", "parameters": { "name": { "required": true, "pattern": "^extensionControllers/[^/]+/operations/[^/]+$", "type": "string", "location": "path", "description": "The name of the operation resource to be cancelled." } } }, "get": { "httpMethod": "GET", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "description": "The name of the operation resource.", "required": true, "pattern": "^extensionControllers/[^/]+/operations/[^/]+$", "location": "path", "type": "string" } }, "flatPath": "v1beta1/extensionControllers/{extensionControllersId}/operations/{operationsId}", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "id": "aiplatform.extensionControllers.operations.get", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "list": { "path": "v1beta1/{+name}/operations", "parameterOrder": [ "name" ], "id": "aiplatform.extensionControllers.operations.list", "httpMethod": "GET", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameters": { "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "The standard list page size." }, "name": { "location": "path", "type": "string", "pattern": "^extensionControllers/[^/]+$", "required": true, "description": "The name of the operation's parent resource." }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" } }, "flatPath": "v1beta1/extensionControllers/{extensionControllersId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "id": "aiplatform.extensionControllers.operations.delete", "parameters": { "name": { "type": "string", "location": "path", "description": "The name of the operation resource to be deleted.", "required": true, "pattern": "^extensionControllers/[^/]+/operations/[^/]+$" } }, "httpMethod": "DELETE", "path": "v1beta1/{+name}", "flatPath": "v1beta1/extensionControllers/{extensionControllersId}/operations/{operationsId}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "wait": { "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.extensionControllers.operations.wait", "flatPath": "v1beta1/extensionControllers/{extensionControllersId}/operations/{operationsId}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:wait", "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to wait on.", "required": true, "location": "path", "type": "string", "pattern": "^extensionControllers/[^/]+/operations/[^/]+$" }, "timeout": { "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "location": "query" } } } } } } }, "pipelineJobs": { "resources": { "operations": { "methods": { "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "id": "aiplatform.pipelineJobs.operations.wait", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait", "path": "v1beta1/{+name}:wait", "httpMethod": "POST", "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation resource to wait on.", "location": "path", "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$" }, "timeout": { "format": "google-duration", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "path": "v1beta1/{+name}", "id": "aiplatform.pipelineJobs.operations.get", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "The name of the operation resource.", "required": true, "location": "path", "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", "type": "string" } }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "httpMethod": "GET", "parameterOrder": [ "name" ] }, "list": { "httpMethod": "GET", "path": "v1beta1/{+name}/operations", "id": "aiplatform.pipelineJobs.operations.list", "parameters": { "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "pageSize": { "type": "integer", "format": "int32", "description": "The standard list page size.", "location": "query" }, "name": { "type": "string", "pattern": "^pipelineJobs/[^/]+$", "description": "The name of the operation's parent resource.", "required": true, "location": "path" }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" } }, "delete": { "id": "aiplatform.pipelineJobs.operations.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "type": "string", "required": true, "location": "path", "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$" } }, "path": "v1beta1/{+name}", "httpMethod": "DELETE", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." }, "cancel": { "parameters": { "name": { "location": "path", "type": "string", "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be cancelled.", "required": true } }, "httpMethod": "POST", "id": "aiplatform.pipelineJobs.operations.cancel", "path": "v1beta1/{+name}:cancel", "flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." } } } } }, "edgeDevices": { "resources": { "operations": { "methods": { "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "flatPath": "v1beta1/edgeDevices/{edgeDevicesId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE", "path": "v1beta1/{+name}", "parameters": { "name": { "pattern": "^edgeDevices/[^/]+/operations/[^/]+$", "type": "string", "location": "path", "required": true, "description": "The name of the operation resource to be deleted." } }, "id": "aiplatform.edgeDevices.operations.delete" }, "wait": { "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/edgeDevices/{edgeDevicesId}/operations/{operationsId}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "path": "v1beta1/{+name}:wait", "id": "aiplatform.edgeDevices.operations.wait", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "type": "string", "location": "path", "description": "The name of the operation resource to wait on.", "pattern": "^edgeDevices/[^/]+/operations/[^/]+$" }, "timeout": { "location": "query", "type": "string", "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." } } }, "get": { "id": "aiplatform.edgeDevices.operations.get", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/edgeDevices/{edgeDevicesId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "required": true, "location": "path", "description": "The name of the operation resource.", "type": "string", "pattern": "^edgeDevices/[^/]+/operations/[^/]+$" } }, "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" } }, "list": { "httpMethod": "GET", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameters": { "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "pageSize": { "type": "integer", "location": "query", "description": "The standard list page size.", "format": "int32" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "name": { "type": "string", "pattern": "^edgeDevices/[^/]+$", "description": "The name of the operation's parent resource.", "location": "path", "required": true } }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/edgeDevices/{edgeDevicesId}/operations", "id": "aiplatform.edgeDevices.operations.list", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "cancel": { "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "id": "aiplatform.edgeDevices.operations.cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/edgeDevices/{edgeDevicesId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:cancel", "parameters": { "name": { "location": "path", "description": "The name of the operation resource to be cancelled.", "type": "string", "required": true, "pattern": "^edgeDevices/[^/]+/operations/[^/]+$" } }, "httpMethod": "POST" } } } } }, "exampleStores": { "resources": { "operations": { "methods": { "delete": { "path": "v1beta1/{+name}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "location": "path", "description": "The name of the operation resource to be deleted.", "pattern": "^exampleStores/[^/]+/operations/[^/]+$", "type": "string", "required": true } }, "parameterOrder": [ "name" ], "id": "aiplatform.exampleStores.operations.delete", "flatPath": "v1beta1/exampleStores/{exampleStoresId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "flatPath": "v1beta1/exampleStores/{exampleStoresId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v1beta1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.exampleStores.operations.list", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation's parent resource.", "location": "path", "pattern": "^exampleStores/[^/]+$" }, "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "pageSize": { "location": "query", "description": "The standard list page size.", "format": "int32", "type": "integer" }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." } }, "httpMethod": "GET" }, "get": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "id": "aiplatform.exampleStores.operations.get", "httpMethod": "GET", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "pattern": "^exampleStores/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource.", "type": "string", "required": true } }, "flatPath": "v1beta1/exampleStores/{exampleStoresId}/operations/{operationsId}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "wait": { "id": "aiplatform.exampleStores.operations.wait", "httpMethod": "POST", "parameters": { "timeout": { "format": "google-duration", "type": "string", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." }, "name": { "type": "string", "pattern": "^exampleStores/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to wait on.", "required": true } }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "path": "v1beta1/{+name}:wait", "parameterOrder": [ "name" ], "flatPath": "v1beta1/exampleStores/{exampleStoresId}/operations/{operationsId}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" } }, "cancel": { "path": "v1beta1/{+name}:cancel", "parameters": { "name": { "required": true, "description": "The name of the operation resource to be cancelled.", "type": "string", "location": "path", "pattern": "^exampleStores/[^/]+/operations/[^/]+$" } }, "parameterOrder": [ "name" ], "httpMethod": "POST", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1beta1/exampleStores/{exampleStoresId}/operations/{operationsId}:cancel", "id": "aiplatform.exampleStores.operations.cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } } } } }, "projects": { "resources": { "locations": { "methods": { "get": { "id": "aiplatform.projects.locations.get", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets information about a location.", "parameters": { "name": { "location": "path", "description": "Resource name for the location.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "GoogleCloudLocationLocation" } }, "augmentPrompt": { "id": "aiplatform.projects.locations.augmentPrompt", "path": "v1beta1/{+parent}:augmentPrompt", "parameters": { "parent": { "required": true, "type": "string", "location": "path", "description": "Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "description": "Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.", "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1AugmentPromptRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:augmentPrompt", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1AugmentPromptResponse" } }, "asyncRetrieveContexts": { "path": "v1beta1/{+parent}:asyncRetrieveContexts", "description": "Asynchronous API to retrieves relevant contexts for a query.", "request": { "$ref": "GoogleCloudAiplatformV1beta1AsyncRetrieveContextsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:asyncRetrieveContexts", "id": "aiplatform.projects.locations.asyncRetrieveContexts", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "httpMethod": "POST", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", "required": true, "location": "path" } } }, "deploy": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:deploy", "parameters": { "destination": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path", "type": "string", "description": "Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}`" } }, "description": "Deploys a model to a new endpoint.", "parameterOrder": [ "destination" ], "id": "aiplatform.projects.locations.deploy", "path": "v1beta1/{+destination}:deploy", "request": { "$ref": "GoogleCloudAiplatformV1beta1DeployRequest" } }, "generateUserScenarios": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:generateUserScenarios", "parameterOrder": [ "location" ], "path": "v1beta1/{+location}:generateUserScenarios", "response": { "$ref": "GoogleCloudAiplatformV1beta1GenerateUserScenariosResponse" }, "parameters": { "location": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The resource name of the Location to run the job. Format: `projects/{project}/locations/{location}`" } }, "httpMethod": "POST", "id": "aiplatform.projects.locations.generateUserScenarios", "description": "Generates user scenarios for agent evaluation.", "request": { "$ref": "GoogleCloudAiplatformV1beta1GenerateUserScenariosRequest" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "generateLossClusters": { "parameterOrder": [ "location" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+location}:generateLossClusters", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.generateLossClusters", "description": "Generates loss clusters from evaluation results. This is a statelss API method that would not modify the EvaluationSet resource.", "parameters": { "location": { "required": true, "type": "string", "location": "path", "description": "Required. The resource name of the Location. Format: `projects/{project}/locations/{location}`", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1GenerateLossClustersRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:generateLossClusters" }, "evaluateInstances": { "path": "v1beta1/{+location}:evaluateInstances", "response": { "$ref": "GoogleCloudAiplatformV1beta1EvaluateInstancesResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:evaluateInstances", "parameterOrder": [ "location" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1EvaluateInstancesRequest" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "location": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "description": "Required. The resource name of the Location to evaluate the instances. Format: `projects/{project}/locations/{location}`", "required": true } }, "description": "Evaluates instances based on a given metric.", "httpMethod": "POST", "id": "aiplatform.projects.locations.evaluateInstances" }, "generateInstanceRubrics": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:generateInstanceRubrics", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations.", "response": { "$ref": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsResponse" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsRequest" }, "parameters": { "location": { "description": "Required. The resource name of the Location to generate rubrics from. Format: `projects/{project}/locations/{location}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true } }, "id": "aiplatform.projects.locations.generateInstanceRubrics", "httpMethod": "POST", "parameterOrder": [ "location" ], "path": "v1beta1/{+location}:generateInstanceRubrics" }, "updateRagEngineConfig": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig", "parameters": { "name": { "required": true, "type": "string", "location": "path", "description": "Identifier. The name of the RagEngineConfig. Format: `projects/{project}/locations/{location}/ragEngineConfig`", "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$" } }, "httpMethod": "PATCH", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Updates a RagEngineConfig.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.updateRagEngineConfig", "path": "v1beta1/{+name}", "request": { "$ref": "GoogleCloudAiplatformV1beta1RagEngineConfig" } }, "deployPublisherModel": { "id": "aiplatform.projects.locations.deployPublisherModel", "deprecated": true, "request": { "$ref": "GoogleCloudAiplatformV1beta1DeployPublisherModelRequest" }, "parameterOrder": [ "destination" ], "parameters": { "destination": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "description": "Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}`", "location": "path" } }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:deployPublisherModel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deploys publisher models.", "path": "v1beta1/{+destination}:deployPublisherModel", "response": { "$ref": "GoogleLongrunningOperation" } }, "list": { "id": "aiplatform.projects.locations.list", "path": "v1beta1/{+name}/locations", "response": { "$ref": "GoogleCloudLocationListLocationsResponse" }, "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "parameterOrder": [ "name" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "filter": { "type": "string", "location": "query", "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160)." }, "name": { "location": "path", "type": "string", "required": true, "description": "The resource that owns the locations collection, if applicable.", "pattern": "^projects/[^/]+$" }, "extraLocationTypes": { "repeated": true, "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "type": "string" }, "pageToken": { "location": "query", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query" } }, "flatPath": "v1beta1/projects/{projectsId}/locations" }, "generateSyntheticData": { "parameters": { "location": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The geographic location where the synthetic data generation request is processed. This should be in the format `projects/{project}/locations/{location}`. For example, `projects/my-project/locations/us-central1`.", "type": "string" } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1GenerateSyntheticDataRequest" }, "parameterOrder": [ "location" ], "id": "aiplatform.projects.locations.generateSyntheticData", "path": "v1beta1/{+location}:generateSyntheticData", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Generates synthetic (artificial) data based on a description", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:generateSyntheticData", "response": { "$ref": "GoogleCloudAiplatformV1beta1GenerateSyntheticDataResponse" } }, "evaluateDataset": { "id": "aiplatform.projects.locations.evaluateDataset", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "location": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project}/locations/{location}`" } }, "description": "Evaluates a dataset based on a set of given metrics.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:evaluateDataset", "path": "v1beta1/{+location}:evaluateDataset", "parameterOrder": [ "location" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1EvaluateDatasetRequest" } }, "getRagEngineConfig": { "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig", "response": { "$ref": "GoogleCloudAiplatformV1beta1RagEngineConfig" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", "location": "path", "description": "Required. The name of the RagEngineConfig resource. Format: `projects/{project}/locations/{location}/ragEngineConfig`", "type": "string", "required": true } }, "id": "aiplatform.projects.locations.getRagEngineConfig", "httpMethod": "GET", "path": "v1beta1/{+name}", "description": "Gets a RagEngineConfig.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "getSemanticGovernancePolicyEngine": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets a SemanticGovernancePolicyEngine. A SemanticGovernancePolicyEngine is a singleton resource that is created when its parent is created, and deleted when its parent is deleted. This method retrieves the current state of the Semantic Governance Policy Engine.", "id": "aiplatform.projects.locations.getSemanticGovernancePolicyEngine", "response": { "$ref": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine" }, "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicyEngine$", "description": "Required. The resource name of the SemanticGovernancePolicyEngine to retrieve. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine", "type": "string", "required": true } }, "path": "v1beta1/{+name}", "httpMethod": "GET" }, "updateSemanticGovernancePolicyEngine": { "request": { "$ref": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine" }, "parameters": { "updateMask": { "format": "google-fieldmask", "type": "string", "location": "query", "description": "Optional. Specifies the fields to be overwritten in the SemanticGovernancePolicyEngine resource by the update. The fields specified in the update_mask are relative to the resource itself. If no update_mask is provided, all fields are overwritten." }, "name": { "description": "Identifier. The resource name of the SemanticGovernancePolicyEngine. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicyEngine$" } }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.updateSemanticGovernancePolicyEngine", "description": "Updates a SemanticGovernancePolicyEngine. This method performs an upsert operation. If the SemanticGovernancePolicyEngine resource does not exist, it will be created. Otherwise, it will be updated.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine", "path": "v1beta1/{+name}" }, "retrieveContexts": { "response": { "$ref": "GoogleCloudAiplatformV1beta1RetrieveContextsResponse" }, "description": "Retrieves relevant contexts for a query.", "request": { "$ref": "GoogleCloudAiplatformV1beta1RetrieveContextsRequest" }, "parameterOrder": [ "parent" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:retrieveContexts", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "description": "Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "path": "v1beta1/{+parent}:retrieveContexts", "httpMethod": "POST", "id": "aiplatform.projects.locations.retrieveContexts" }, "askContexts": { "description": "Agentic Retrieval Ask API for RAG.", "path": "v1beta1/{+parent}:askContexts", "httpMethod": "POST", "parameters": { "parent": { "required": true, "description": "Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1AskContextsResponse" }, "id": "aiplatform.projects.locations.askContexts", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:askContexts", "request": { "$ref": "GoogleCloudAiplatformV1beta1AskContextsRequest" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "recommendSpec": { "httpMethod": "POST", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "description": "Required. The resource name of the Location from which to recommend specs. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", "location": "path" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:recommendSpec", "id": "aiplatform.projects.locations.recommendSpec", "response": { "$ref": "GoogleCloudAiplatformV1beta1RecommendSpecResponse" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1RecommendSpecRequest" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets a Model's spec recommendations. This API is called by UI, SDK, and internal.", "path": "v1beta1/{+parent}:recommendSpec", "parameterOrder": [ "parent" ] }, "corroborateContent": { "httpMethod": "POST", "description": "Given an input text, it returns a score that evaluates the factuality of the text. It also extracts and returns claims from the text and provides supporting facts.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "location": "path", "description": "Required. The resource name of the Location from which to corroborate text. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1CorroborateContentRequest" }, "response": { "$ref": "GoogleCloudAiplatformV1beta1CorroborateContentResponse" }, "id": "aiplatform.projects.locations.corroborateContent", "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}:corroborateContent", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:corroborateContent" } }, "resources": { "metadataStores": { "methods": { "delete": { "id": "aiplatform.projects.locations.metadataStores.delete", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}", "description": "Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "DELETE", "parameters": { "force": { "location": "query", "deprecated": true, "description": "Deprecated: Field is no longer supported.", "type": "boolean" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "required": true, "description": "Required. The resource name of the MetadataStore to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "type": "string", "location": "path" } } }, "get": { "id": "aiplatform.projects.locations.metadataStores.get", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "description": "Retrieves a specific MetadataStore.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "type": "string" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1MetadataStore" } }, "list": { "path": "v1beta1/{+parent}/metadataStores", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores", "parameters": { "pageToken": { "type": "string", "description": "A page token, received from a previous MetadataService.ListMetadataStores call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)", "location": "query" }, "parent": { "location": "path", "description": "Required. The Location whose MetadataStores should be listed. Format: `projects/{project}/locations/{location}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "pageSize": { "format": "int32", "type": "integer", "description": "The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", "location": "query" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1ListMetadataStoresResponse" }, "id": "aiplatform.projects.locations.metadataStores.list", "httpMethod": "GET", "description": "Lists MetadataStores for a Location.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ] }, "create": { "id": "aiplatform.projects.locations.metadataStores.create", "description": "Initializes a MetadataStore, including allocation of resources.", "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/metadataStores", "request": { "$ref": "GoogleCloudAiplatformV1beta1MetadataStore" }, "parameters": { "parent": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project}/locations/{location}/`" }, "metadataStoreId": { "description": "The {metadatastore} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.)", "type": "string", "location": "query" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" } } }, "resources": { "contexts": { "methods": { "addContextArtifactsAndExecutions": { "parameterOrder": [ "context" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1AddContextArtifactsAndExecutionsRequest" }, "response": { "$ref": "GoogleCloudAiplatformV1beta1AddContextArtifactsAndExecutionsResponse" }, "path": "v1beta1/{+context}:addContextArtifactsAndExecutions", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextArtifactsAndExecutions", "description": "Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped.", "id": "aiplatform.projects.locations.metadataStores.contexts.addContextArtifactsAndExecutions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "context": { "type": "string", "required": true, "description": "Required. The resource name of the Context that the Artifacts and Executions belong to. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", "location": "path" } } }, "queryContextLineageSubgraph": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:queryContextLineageSubgraph", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "context" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1LineageSubgraph" }, "path": "v1beta1/{+context}:queryContextLineageSubgraph", "httpMethod": "GET", "id": "aiplatform.projects.locations.metadataStores.contexts.queryContextLineageSubgraph", "parameters": { "context": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", "description": "Required. The resource name of the Context whose Artifacts and Executions should be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000." } }, "description": "Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph." }, "purge": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts:purge", "parameterOrder": [ "parent" ], "id": "aiplatform.projects.locations.metadataStores.contexts.purge", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Purges Contexts.", "parameters": { "parent": { "location": "path", "type": "string", "required": true, "description": "Required. The metadata store to purge Contexts from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$" } }, "path": "v1beta1/{+parent}/contexts:purge", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1PurgeContextsRequest" } }, "get": { "httpMethod": "GET", "path": "v1beta1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name of the Context to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`", "required": true } }, "description": "Retrieves a specific Context.", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1Context" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.metadataStores.contexts.get" }, "list": { "parameters": { "filter": { "type": "string", "description": "Filter specifying the boolean condition for the Contexts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = \"test\"`. Supported fields include: `name`, `display_name`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0`. In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` * **Parent Child filtering**: To filter Contexts based on parent-child relationship use the HAS operator as follows: ``` parent_contexts: \"projects//locations//metadataStores//contexts/\" child_contexts: \"projects//locations//metadataStores//contexts/\" ``` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.", "location": "query" }, "pageSize": { "type": "integer", "description": "The maximum number of Contexts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", "format": "int32", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "location": "path", "type": "string", "description": "Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "required": true }, "pageToken": { "location": "query", "type": "string", "description": "A page token, received from a previous MetadataService.ListContexts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)" }, "orderBy": { "location": "query", "type": "string", "description": "How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a \" desc\" suffix; for example: \"foo desc, bar\". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details." } }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/contexts", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListContextsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Contexts on the MetadataStore.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts", "id": "aiplatform.projects.locations.metadataStores.contexts.list" }, "removeContextChildren": { "response": { "$ref": "GoogleCloudAiplatformV1beta1RemoveContextChildrenResponse" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1RemoveContextChildrenRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:removeContextChildren", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.metadataStores.contexts.removeContextChildren", "parameterOrder": [ "context" ], "path": "v1beta1/{+context}:removeContextChildren", "description": "Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped.", "httpMethod": "POST", "parameters": { "context": { "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", "required": true, "description": "Required. The resource name of the parent Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`", "location": "path", "type": "string" } } }, "patch": { "id": "aiplatform.projects.locations.metadataStores.contexts.patch", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}", "description": "Updates a stored Context.", "response": { "$ref": "GoogleCloudAiplatformV1beta1Context" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1Context" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", "location": "path", "type": "string", "required": true, "description": "Immutable. The resource name of the Context." }, "allowMissing": { "location": "query", "description": "If set to true, and the Context is not found, a new Context is created.", "type": "boolean" }, "updateMask": { "location": "query", "description": "Optional. A FieldMask indicating which fields should be updated.", "type": "string", "format": "google-fieldmask" } }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "addContextChildren": { "request": { "$ref": "GoogleCloudAiplatformV1beta1AddContextChildrenRequest" }, "description": "Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error.", "parameterOrder": [ "context" ], "id": "aiplatform.projects.locations.metadataStores.contexts.addContextChildren", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+context}:addContextChildren", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextChildren", "parameters": { "context": { "required": true, "description": "Required. The resource name of the parent Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1AddContextChildrenResponse" }, "httpMethod": "POST" }, "delete": { "httpMethod": "DELETE", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "force": { "description": "The force deletion semantics is still undefined. Users should not use this field.", "location": "query", "type": "boolean" }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", "type": "string", "required": true, "description": "Required. The resource name of the Context to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`" }, "etag": { "type": "string", "location": "query", "description": "Optional. The etag of the Context to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.metadataStores.contexts.delete", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "description": "Deletes a stored Context." }, "create": { "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/contexts", "request": { "$ref": "GoogleCloudAiplatformV1beta1Context" }, "id": "aiplatform.projects.locations.metadataStores.contexts.create", "description": "Creates a Context associated with a MetadataStore.", "response": { "$ref": "GoogleCloudAiplatformV1beta1Context" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts", "parameters": { "contextId": { "type": "string", "location": "query", "description": "The {context} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`. If not provided, the Context's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.)" }, "parent": { "required": true, "description": "Required. The resource name of the MetadataStore where the Context should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$" } }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "operations": { "methods": { "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.metadataStores.contexts.operations.get", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource.", "required": true, "type": "string" } }, "httpMethod": "GET" }, "cancel": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.projects.locations.metadataStores.contexts.operations.cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "path": "v1beta1/{+name}:cancel", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST" }, "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "required": true, "description": "The name of the operation resource to be deleted." } }, "httpMethod": "DELETE", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", "id": "aiplatform.projects.locations.metadataStores.contexts.operations.delete", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." }, "wait": { "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait", "id": "aiplatform.projects.locations.metadataStores.contexts.operations.wait", "httpMethod": "POST", "parameters": { "timeout": { "format": "google-duration", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string" }, "name": { "location": "path", "description": "The name of the operation resource to wait on.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.metadataStores.contexts.operations.list", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1beta1/{+name}/operations", "parameterOrder": [ "name" ], "parameters": { "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "name": { "description": "The name of the operation's parent resource.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", "required": true, "location": "path" }, "pageSize": { "format": "int32", "description": "The standard list page size.", "type": "integer", "location": "query" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } } } } }, "executions": { "methods": { "create": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1Execution" }, "description": "Creates an Execution associated with a MetadataStore.", "id": "aiplatform.projects.locations.metadataStores.executions.create", "request": { "$ref": "GoogleCloudAiplatformV1beta1Execution" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "required": true, "description": "Required. The resource name of the MetadataStore where the Execution should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "location": "path", "type": "string" }, "executionId": { "type": "string", "description": "The {execution} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.)", "location": "query" } }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "path": "v1beta1/{+parent}/executions" }, "patch": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.metadataStores.executions.patch", "request": { "$ref": "GoogleCloudAiplatformV1beta1Execution" }, "path": "v1beta1/{+name}", "response": { "$ref": "GoogleCloudAiplatformV1beta1Execution" }, "description": "Updates a stored Execution.", "parameters": { "updateMask": { "format": "google-fieldmask", "type": "string", "location": "query", "description": "Optional. A FieldMask indicating which fields should be updated." }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", "location": "path", "description": "Output only. The resource name of the Execution.", "type": "string", "required": true }, "allowMissing": { "description": "If set to true, and the Execution is not found, a new Execution is created.", "type": "boolean", "location": "query" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}", "httpMethod": "PATCH" }, "queryExecutionInputsAndOutputs": { "parameters": { "execution": { "description": "Required. The resource name of the Execution whose input and output Artifacts should be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", "location": "path" } }, "path": "v1beta1/{+execution}:queryExecutionInputsAndOutputs", "parameterOrder": [ "execution" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudAiplatformV1beta1LineageSubgraph" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:queryExecutionInputsAndOutputs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.metadataStores.executions.queryExecutionInputsAndOutputs", "description": "Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events." }, "purge": { "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The metadata store to purge Executions from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "required": true } }, "id": "aiplatform.projects.locations.metadataStores.executions.purge", "httpMethod": "POST", "path": "v1beta1/{+parent}/executions:purge", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Purges Executions.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions:purge", "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1PurgeExecutionsRequest" } }, "get": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", "type": "string", "location": "path", "description": "Required. The resource name of the Execution to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`", "required": true } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.metadataStores.executions.get", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleCloudAiplatformV1beta1Execution" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}", "description": "Retrieves a specific Execution." }, "addExecutionEvents": { "parameterOrder": [ "execution" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1AddExecutionEventsResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:addExecutionEvents", "description": "Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped.", "request": { "$ref": "GoogleCloudAiplatformV1beta1AddExecutionEventsRequest" }, "httpMethod": "POST", "parameters": { "execution": { "required": true, "description": "Required. The resource name of the Execution that the Events connect Artifacts with. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", "type": "string" } }, "id": "aiplatform.projects.locations.metadataStores.executions.addExecutionEvents", "path": "v1beta1/{+execution}:addExecutionEvents" }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Executions in the MetadataStore.", "path": "v1beta1/{+parent}/executions", "id": "aiplatform.projects.locations.metadataStores.executions.list", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions", "parameterOrder": [ "parent" ], "parameters": { "orderBy": { "location": "query", "type": "string", "description": "How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a \" desc\" suffix; for example: \"foo desc, bar\". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details." }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "The maximum number of Executions to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "required": true, "type": "string", "description": "Required. The MetadataStore whose Executions should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "location": "path" }, "pageToken": { "type": "string", "description": "A page token, received from a previous MetadataService.ListExecutions call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with an INVALID_ARGUMENT error.)", "location": "query" }, "filter": { "description": "Filter specifying the boolean condition for the Executions to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = \"test\"`. Supported fields include: `name`, `display_name`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..` For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` * **Context based filtering**: To filter Executions based on the contexts to which they belong use the function operator with the full resource name: `in_context()`. For example: `in_context(\"projects//locations//metadataStores//contexts/\")` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.", "location": "query", "type": "string" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1ListExecutionsResponse" }, "httpMethod": "GET" }, "delete": { "id": "aiplatform.projects.locations.metadataStores.executions.delete", "description": "Deletes an Execution.", "path": "v1beta1/{+name}", "parameters": { "name": { "required": true, "description": "Required. The resource name of the Execution to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", "type": "string" }, "etag": { "location": "query", "type": "string", "description": "Optional. The etag of the Execution to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION." } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" } } }, "resources": { "operations": { "methods": { "cancel": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "path": "v1beta1/{+name}:cancel", "id": "aiplatform.projects.locations.metadataStores.executions.operations.cancel", "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "location": "path", "description": "The name of the operation resource to be cancelled.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$" } }, "response": { "$ref": "GoogleProtobufEmpty" } }, "wait": { "id": "aiplatform.projects.locations.metadataStores.executions.operations.wait", "parameters": { "timeout": { "format": "google-duration", "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query" }, "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to wait on." } }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "path": "v1beta1/{+name}:wait", "parameterOrder": [ "name" ] }, "get": { "id": "aiplatform.projects.locations.metadataStores.executions.operations.get", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", "path": "v1beta1/{+name}", "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "GET", "parameterOrder": [ "name" ] }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.metadataStores.executions.operations.delete", "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation resource to be deleted.", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "location": "path" } }, "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}" }, "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1beta1/{+name}/operations", "parameters": { "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "pageSize": { "format": "int32", "description": "The standard list page size.", "type": "integer", "location": "query" }, "name": { "description": "The name of the operation's parent resource.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", "type": "string" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" } }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.metadataStores.executions.operations.list", "parameterOrder": [ "name" ] } } } } }, "artifacts": { "methods": { "patch": { "description": "Updates a stored Artifact.", "id": "aiplatform.projects.locations.metadataStores.artifacts.patch", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}", "request": { "$ref": "GoogleCloudAiplatformV1beta1Artifact" }, "httpMethod": "PATCH", "parameters": { "updateMask": { "type": "string", "format": "google-fieldmask", "description": "Optional. A FieldMask indicating which fields should be updated.", "location": "query" }, "allowMissing": { "type": "boolean", "description": "If set to true, and the Artifact is not found, a new Artifact is created.", "location": "query" }, "name": { "location": "path", "description": "Output only. The resource name of the Artifact.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1Artifact" } }, "get": { "httpMethod": "GET", "parameters": { "name": { "required": true, "location": "path", "description": "Required. The resource name of the Artifact to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", "type": "string" } }, "id": "aiplatform.projects.locations.metadataStores.artifacts.get", "response": { "$ref": "GoogleCloudAiplatformV1beta1Artifact" }, "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}", "parameterOrder": [ "name" ], "description": "Retrieves a specific Artifact." }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "type": "string", "location": "path", "description": "Required. The resource name of the Artifact to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$" }, "etag": { "location": "query", "description": "Optional. The etag of the Artifact to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.", "type": "string" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "DELETE", "id": "aiplatform.projects.locations.metadataStores.artifacts.delete", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}", "description": "Deletes an Artifact.", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ] }, "queryArtifactLineageSubgraph": { "id": "aiplatform.projects.locations.metadataStores.artifacts.queryArtifactLineageSubgraph", "httpMethod": "GET", "description": "Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}:queryArtifactLineageSubgraph", "parameters": { "filter": { "description": "Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = \"test\"` Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.", "type": "string", "location": "query" }, "maxHops": { "description": "Specifies the size of the lineage graph in terms of number of hops from the specified artifact. Negative Value: INVALID_ARGUMENT error is returned 0: Only input artifact is returned. No value: Transitive closure is performed to return the complete graph.", "location": "query", "format": "int32", "type": "integer" }, "artifact": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", "required": true, "type": "string", "description": "Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000." } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1LineageSubgraph" }, "path": "v1beta1/{+artifact}:queryArtifactLineageSubgraph", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "artifact" ] }, "purge": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts:purge", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.metadataStores.artifacts.purge", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+parent}/artifacts:purge", "description": "Purges Artifacts.", "httpMethod": "POST", "parameters": { "parent": { "location": "path", "description": "Required. The metadata store to purge Artifacts from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "type": "string" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1PurgeArtifactsRequest" } }, "list": { "parameters": { "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100." }, "parent": { "description": "Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "location": "path", "required": true }, "pageToken": { "type": "string", "location": "query", "description": "A page token, received from a previous MetadataService.ListArtifacts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)" }, "orderBy": { "location": "query", "type": "string", "description": "How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a \" desc\" suffix; for example: \"foo desc, bar\". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details." }, "filter": { "type": "string", "description": "Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = \"test\"`. Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` * **Context based filtering**: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name `in_context()`. For example: `in_context(\"projects//locations//metadataStores//contexts/\")` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "description": "Lists Artifacts in the MetadataStore.", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListArtifactsResponse" }, "parameterOrder": [ "parent" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts", "path": "v1beta1/{+parent}/artifacts", "id": "aiplatform.projects.locations.metadataStores.artifacts.list" }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "artifactId": { "location": "query", "description": "The {artifact} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.)", "type": "string" }, "parent": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "description": "Required. The resource name of the MetadataStore where the Artifact should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "type": "string" } }, "id": "aiplatform.projects.locations.metadataStores.artifacts.create", "request": { "$ref": "GoogleCloudAiplatformV1beta1Artifact" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts", "path": "v1beta1/{+parent}/artifacts", "parameterOrder": [ "parent" ], "description": "Creates an Artifact associated with a MetadataStore.", "response": { "$ref": "GoogleCloudAiplatformV1beta1Artifact" } } }, "resources": { "operations": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.get", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "path": "v1beta1/{+name}", "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", "parameters": { "name": { "required": true, "description": "The name of the operation resource.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$" } } }, "delete": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "location": "path" } } }, "wait": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait", "parameters": { "name": { "location": "path", "description": "The name of the operation resource to wait on.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$" }, "timeout": { "location": "query", "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string" } }, "path": "v1beta1/{+name}:wait", "httpMethod": "POST", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.wait" }, "cancel": { "path": "v1beta1/{+name}:cancel", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "httpMethod": "POST", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.cancel" }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.list", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", "required": true, "type": "string", "location": "path" }, "returnPartialSuccess": { "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query" }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "pageSize": { "type": "integer", "description": "The standard list page size.", "format": "int32", "location": "query" }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" } }, "httpMethod": "GET", "path": "v1beta1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations" } } } } }, "operations": { "methods": { "delete": { "id": "aiplatform.projects.locations.metadataStores.operations.delete", "httpMethod": "DELETE", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path" } }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" } }, "get": { "parameters": { "name": { "location": "path", "description": "The name of the operation resource.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "GET", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.metadataStores.operations.get", "path": "v1beta1/{+name}" }, "wait": { "id": "aiplatform.projects.locations.metadataStores.operations.wait", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path", "description": "The name of the operation resource to wait on." }, "timeout": { "type": "string", "format": "google-duration", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." } }, "httpMethod": "POST", "path": "v1beta1/{+name}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done." }, "cancel": { "id": "aiplatform.projects.locations.metadataStores.operations.cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:cancel", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$", "type": "string", "required": true, "description": "The name of the operation resource to be cancelled." } }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "id": "aiplatform.projects.locations.metadataStores.operations.list", "httpMethod": "GET", "path": "v1beta1/{+name}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameters": { "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "required": true, "description": "The name of the operation's parent resource.", "location": "path", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "The standard list page size." }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] } } }, "metadataSchemas": { "methods": { "create": { "parameters": { "parent": { "description": "Required. The resource name of the MetadataStore where the MetadataSchema should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "required": true, "type": "string", "location": "path" }, "metadataSchemaId": { "description": "The {metadata_schema} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.)", "location": "query", "type": "string" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas", "httpMethod": "POST", "response": { "$ref": "GoogleCloudAiplatformV1beta1MetadataSchema" }, "description": "Creates a MetadataSchema.", "id": "aiplatform.projects.locations.metadataStores.metadataSchemas.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1MetadataSchema" }, "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/metadataSchemas" }, "list": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageSize": { "location": "query", "description": "The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", "format": "int32", "type": "integer" }, "pageToken": { "location": "query", "description": "A page token, received from a previous MetadataService.ListMetadataSchemas call. Provide this to retrieve the next page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "type": "string", "location": "path", "description": "Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "required": true }, "filter": { "location": "query", "description": "A query to filter available MetadataSchemas for matching results.", "type": "string" } }, "description": "Lists MetadataSchemas.", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListMetadataSchemasResponse" }, "id": "aiplatform.projects.locations.metadataStores.metadataSchemas.list", "httpMethod": "GET", "path": "v1beta1/{+parent}/metadataSchemas", "parameterOrder": [ "parent" ] }, "get": { "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "name": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/metadataSchemas/[^/]+$", "description": "Required. The resource name of the MetadataSchema to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}`", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1MetadataSchema" }, "id": "aiplatform.projects.locations.metadataStores.metadataSchemas.get", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas/{metadataSchemasId}", "description": "Retrieves a specific MetadataSchema." } } } } }, "tensorboards": { "resources": { "operations": { "methods": { "wait": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameters": { "name": { "description": "The name of the operation resource to wait on.", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$" }, "timeout": { "type": "string", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration" } }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait", "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.tensorboards.operations.wait" }, "get": { "parameters": { "name": { "description": "The name of the operation resource.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", "location": "path" } }, "httpMethod": "GET", "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.tensorboards.operations.get", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "delete": { "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path", "description": "The name of the operation resource to be deleted." } }, "parameterOrder": [ "name" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.tensorboards.operations.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}" }, "list": { "id": "aiplatform.projects.locations.tensorboards.operations.list", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1beta1/{+name}/operations", "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameters": { "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "name": { "required": true, "type": "string", "location": "path", "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$" }, "pageSize": { "location": "query", "format": "int32", "description": "The standard list page size.", "type": "integer" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "cancel": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "id": "aiplatform.projects.locations.tensorboards.operations.cancel", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel", "path": "v1beta1/{+name}:cancel", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be cancelled.", "location": "path", "required": true } }, "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "POST" } } }, "experiments": { "methods": { "patch": { "id": "aiplatform.projects.locations.tensorboards.experiments.patch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "updateMask": { "format": "google-fieldmask", "type": "string", "location": "query", "description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified." }, "name": { "description": "Output only. Name of the TensorboardExperiment. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "location": "path", "required": true } }, "description": "Updates a TensorboardExperiment.", "httpMethod": "PATCH", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}" }, "create": { "id": "aiplatform.projects.locations.tensorboards.experiments.create", "request": { "$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment" }, "response": { "$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments", "description": "Creates a TensorboardExperiment.", "httpMethod": "POST", "path": "v1beta1/{+parent}/experiments", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "parameters": { "tensorboardExperimentId": { "type": "string", "description": "Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`.", "location": "query" }, "parent": { "location": "path", "description": "Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$" } } }, "write": { "parameterOrder": [ "tensorboardExperiment" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.", "request": { "$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardExperimentDataRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write", "response": { "$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardExperimentDataResponse" }, "parameters": { "tensorboardExperiment": { "description": "Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$" } }, "id": "aiplatform.projects.locations.tensorboards.experiments.write", "path": "v1beta1/{+tensorboardExperiment}:write", "httpMethod": "POST" }, "get": { "id": "aiplatform.projects.locations.tensorboards.experiments.get", "path": "v1beta1/{+name}", "description": "Gets a TensorboardExperiment.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "parameters": { "name": { "description": "Required. The name of the TensorboardExperiment resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "type": "string", "required": true, "location": "path" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", "httpMethod": "GET", "response": { "$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment" } }, "delete": { "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a TensorboardExperiment.", "path": "v1beta1/{+name}", "httpMethod": "DELETE", "id": "aiplatform.projects.locations.tensorboards.experiments.delete", "parameters": { "name": { "location": "path", "description": "Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "type": "string", "required": true } }, "parameterOrder": [ "name" ] }, "list": { "httpMethod": "GET", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListTensorboardExperimentsResponse" }, "parameters": { "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000." }, "orderBy": { "description": "Field to use to sort the list.", "type": "string", "location": "query" }, "parent": { "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "description": "Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`" }, "pageToken": { "description": "A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token.", "location": "query", "type": "string" }, "readMask": { "format": "google-fieldmask", "type": "string", "description": "Mask specifying which fields to read.", "location": "query" }, "filter": { "location": "query", "description": "Lists the TensorboardExperiments that match the filter expression.", "type": "string" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments", "description": "Lists TensorboardExperiments in a Location.", "path": "v1beta1/{+parent}/experiments", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "id": "aiplatform.projects.locations.tensorboards.experiments.list" }, "batchCreate": { "description": "Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate", "path": "v1beta1/{+parent}:batchCreate", "response": { "$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardTimeSeriesResponse" }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardTimeSeriesRequest" }, "id": "aiplatform.projects.locations.tensorboards.experiments.batchCreate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "parent": { "required": true, "type": "string", "description": "Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$" } } } }, "resources": { "operations": { "methods": { "delete": { "id": "aiplatform.projects.locations.tensorboards.experiments.operations.delete", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "parameters": { "name": { "type": "string", "required": true, "description": "The name of the operation resource to be deleted.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$" } }, "path": "v1beta1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", "parameterOrder": [ "name" ] }, "list": { "parameters": { "pageSize": { "location": "query", "format": "int32", "description": "The standard list page size.", "type": "integer" }, "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "name": { "required": true, "type": "string", "location": "path", "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$" }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "id": "aiplatform.projects.locations.tensorboards.experiments.operations.list", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations", "path": "v1beta1/{+name}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.tensorboards.experiments.operations.get", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "required": true, "type": "string", "description": "The name of the operation resource." } } }, "cancel": { "id": "aiplatform.projects.locations.tensorboards.experiments.operations.cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "name": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be cancelled." } }, "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel", "path": "v1beta1/{+name}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameterOrder": [ "name" ] }, "wait": { "path": "v1beta1/{+name}:wait", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "timeout": { "type": "string", "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query" }, "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to wait on." } }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "id": "aiplatform.projects.locations.tensorboards.experiments.operations.wait", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } } }, "runs": { "methods": { "patch": { "description": "Updates a TensorboardRun.", "response": { "$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" }, "id": "aiplatform.projects.locations.tensorboards.experiments.runs.patch", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", "required": true, "description": "Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", "location": "path" }, "updateMask": { "description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" } }, "write": { "description": "Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.", "id": "aiplatform.projects.locations.tensorboards.experiments.runs.write", "httpMethod": "POST", "parameterOrder": [ "tensorboardRun" ], "path": "v1beta1/{+tensorboardRun}:write", "parameters": { "tensorboardRun": { "description": "Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}:write", "response": { "$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardRunDataResponse" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardRunDataRequest" } }, "batchCreate": { "response": { "$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardRunsResponse" }, "path": "v1beta1/{+parent}/runs:batchCreate", "request": { "$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardRunsRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Batch create TensorboardRuns.", "httpMethod": "POST", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "location": "path", "description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The parent field in the CreateTensorboardRunRequest messages must match this field.", "required": true } }, "parameterOrder": [ "parent" ], "id": "aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate" }, "get": { "description": "Gets a TensorboardRun.", "httpMethod": "GET", "parameters": { "name": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", "description": "Required. The name of the TensorboardRun resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "id": "aiplatform.projects.locations.tensorboards.experiments.runs.get", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a TensorboardRun.", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", "parameters": { "name": { "description": "Required. The name of the TensorboardRun to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", "required": true, "type": "string" } }, "httpMethod": "DELETE", "id": "aiplatform.projects.locations.tensorboards.experiments.runs.delete", "response": { "$ref": "GoogleLongrunningOperation" } }, "create": { "description": "Creates a TensorboardRun.", "path": "v1beta1/{+parent}/runs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" }, "response": { "$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string", "description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", "location": "path" }, "tensorboardRunId": { "location": "query", "type": "string", "description": "Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`." } }, "id": "aiplatform.projects.locations.tensorboards.experiments.runs.create", "httpMethod": "POST" }, "list": { "id": "aiplatform.projects.locations.tensorboards.experiments.runs.list", "path": "v1beta1/{+parent}/runs", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1ListTensorboardRunsResponse" }, "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "description": "Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", "location": "path" }, "orderBy": { "type": "string", "description": "Field to use to sort the list.", "location": "query" }, "pageSize": { "format": "int32", "type": "integer", "description": "The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", "location": "query" }, "filter": { "type": "string", "description": "Lists the TensorboardRuns that match the filter expression.", "location": "query" }, "readMask": { "type": "string", "description": "Mask specifying which fields to read.", "location": "query", "format": "google-fieldmask" }, "pageToken": { "description": "A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token.", "location": "query", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "httpMethod": "GET", "description": "Lists TensorboardRuns in a Location.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs" } }, "resources": { "operations": { "methods": { "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to be deleted.", "type": "string", "location": "path" } }, "httpMethod": "DELETE" }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.get", "httpMethod": "GET", "parameters": { "name": { "required": true, "description": "The name of the operation resource.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$" } }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" } }, "cancel": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "description": "The name of the operation resource to be cancelled.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", "type": "string" } }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "httpMethod": "POST", "path": "v1beta1/{+name}:cancel", "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel" }, "list": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1beta1/{+name}/operations", "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.list", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the operation's parent resource.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", "type": "string", "location": "path" }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "pageSize": { "format": "int32", "description": "The standard list page size.", "type": "integer", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "httpMethod": "GET" }, "wait": { "httpMethod": "POST", "parameters": { "name": { "required": true, "description": "The name of the operation resource to wait on.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$" }, "timeout": { "location": "query", "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string" } }, "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" } } } }, "timeSeries": { "methods": { "create": { "description": "Creates a TensorboardTimeSeries.", "request": { "$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" }, "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/timeSeries", "httpMethod": "POST", "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", "required": true, "description": "Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", "type": "string", "location": "path" }, "tensorboardTimeSeriesId": { "location": "query", "description": "Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match \"a-z0-9{0, 127}\"", "type": "string" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries" }, "read": { "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read", "response": { "$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardTimeSeriesDataResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:read", "httpMethod": "GET", "path": "v1beta1/{+tensorboardTimeSeries}:read", "parameterOrder": [ "tensorboardTimeSeries" ], "parameters": { "tensorboardTimeSeries": { "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", "description": "Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", "required": true, "type": "string", "location": "path" }, "maxDataPoints": { "description": "The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data.", "format": "int32", "type": "integer", "location": "query" }, "filter": { "description": "Reads the TensorboardTimeSeries' data that match the filter expression.", "location": "query", "type": "string" } }, "description": "Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k." }, "patch": { "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", "location": "path", "description": "Output only. Name of the TensorboardTimeSeries.", "type": "string", "required": true }, "updateMask": { "type": "string", "location": "query", "format": "google-fieldmask", "description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified." } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", "parameterOrder": [ "name" ], "description": "Updates a TensorboardTimeSeries.", "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch", "path": "v1beta1/{+name}", "request": { "$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" } }, "exportTensorboardTimeSeries": { "path": "v1beta1/{+tensorboardTimeSeries}:exportTensorboardTimeSeries", "parameterOrder": [ "tensorboardTimeSeries" ], "description": "Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1ExportTensorboardTimeSeriesDataResponse" }, "parameters": { "tensorboardTimeSeries": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", "description": "Required. The resource name of the TensorboardTimeSeries to export data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", "type": "string", "location": "path" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1ExportTensorboardTimeSeriesDataRequest" }, "httpMethod": "POST", "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries" }, "get": { "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get", "response": { "$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" }, "parameters": { "name": { "required": true, "description": "Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$" } }, "path": "v1beta1/{+name}", "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", "description": "Gets a TensorboardTimeSeries.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "parameterOrder": [ "name" ] }, "readBlobData": { "httpMethod": "GET", "path": "v1beta1/{+timeSeries}:readBlobData", "parameters": { "timeSeries": { "location": "path", "type": "string", "description": "Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$" }, "blobIds": { "repeated": true, "type": "string", "location": "query", "description": "IDs of the blobs to read." } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardBlobDataResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:readBlobData", "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData", "parameterOrder": [ "timeSeries" ], "description": "Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] }, "list": { "parameterOrder": [ "parent" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListTensorboardTimeSeriesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "path": "v1beta1/{+parent}/timeSeries", "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list", "parameters": { "parent": { "required": true, "description": "Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$" }, "readMask": { "format": "google-fieldmask", "location": "query", "type": "string", "description": "Mask specifying which fields to read." }, "pageSize": { "format": "int32", "description": "The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", "type": "integer", "location": "query" }, "pageToken": { "type": "string", "description": "A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token.", "location": "query" }, "filter": { "type": "string", "description": "Lists the TensorboardTimeSeries that match the filter expression.", "location": "query" }, "orderBy": { "location": "query", "type": "string", "description": "Field to use to sort the list." } }, "httpMethod": "GET", "description": "Lists TensorboardTimeSeries in a Location." }, "delete": { "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", "description": "Deletes a TensorboardTimeSeries.", "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "description": "Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$" } }, "parameterOrder": [ "name" ] } }, "resources": { "operations": { "methods": { "wait": { "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait", "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", "type": "string", "location": "path" }, "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "format": "google-duration", "location": "query" } }, "httpMethod": "POST" }, "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameters": { "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", "location": "path", "type": "string", "required": true, "description": "The name of the operation's parent resource." }, "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1beta1/{+name}/operations", "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", "required": true, "location": "path", "description": "The name of the operation resource.", "type": "string" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" } }, "delete": { "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "httpMethod": "DELETE", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", "parameters": { "name": { "location": "path", "description": "The name of the operation resource to be deleted.", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "GoogleProtobufEmpty" } }, "cancel": { "path": "v1beta1/{+name}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel", "parameters": { "name": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be cancelled.", "location": "path" } }, "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel", "httpMethod": "POST", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" } } } } } } } } } } }, "methods": { "list": { "httpMethod": "GET", "path": "v1beta1/{+parent}/tensorboards", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListTensorboardsResponse" }, "parameters": { "readMask": { "description": "Mask specifying which fields to read.", "format": "google-fieldmask", "type": "string", "location": "query" }, "filter": { "location": "query", "description": "Lists the Tensorboards that match the filter expression.", "type": "string" }, "orderBy": { "type": "string", "location": "query", "description": "Field to use to sort the list." }, "pageSize": { "description": "The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100.", "type": "integer", "location": "query", "format": "int32" }, "pageToken": { "description": "A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The resource name of the Location to list Tensorboards. Format: `projects/{project}/locations/{location}`" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards", "parameterOrder": [ "parent" ], "id": "aiplatform.projects.locations.tensorboards.list", "description": "Lists Tensorboards in a Location." }, "readUsage": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "tensorboard" ], "parameters": { "tensorboard": { "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "type": "string", "location": "path", "description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "required": true } }, "description": "Returns a list of monthly active users for a given TensorBoard instance.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readUsage", "response": { "$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardUsageResponse" }, "path": "v1beta1/{+tensorboard}:readUsage", "id": "aiplatform.projects.locations.tensorboards.readUsage" }, "delete": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", "parameters": { "name": { "description": "Required. The name of the Tensorboard to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$" } }, "id": "aiplatform.projects.locations.tensorboards.delete", "httpMethod": "DELETE", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Deletes a Tensorboard.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "parameterOrder": [ "name" ] }, "batchRead": { "parameters": { "tensorboard": { "required": true, "description": "Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$" }, "timeSeries": { "description": "Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", "repeated": true, "type": "string", "location": "query" } }, "httpMethod": "GET", "path": "v1beta1/{+tensorboard}:batchRead", "id": "aiplatform.projects.locations.tensorboards.batchRead", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead", "parameterOrder": [ "tensorboard" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1BatchReadTensorboardTimeSeriesDataResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned." }, "readSize": { "response": { "$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardSizeResponse" }, "parameterOrder": [ "tensorboard" ], "path": "v1beta1/{+tensorboard}:readSize", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.tensorboards.readSize", "httpMethod": "GET", "parameters": { "tensorboard": { "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "location": "path", "type": "string", "required": true, "description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`" } }, "description": "Returns the storage size for a given TensorBoard instance." }, "get": { "description": "Gets a Tensorboard.", "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "type": "string", "required": true } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1Tensorboard" }, "id": "aiplatform.projects.locations.tensorboards.get", "httpMethod": "GET" }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+parent}/tensorboards", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards", "parameters": { "parent": { "description": "Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project}/locations/{location}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1Tensorboard" }, "id": "aiplatform.projects.locations.tensorboards.create", "description": "Creates a Tensorboard.", "parameterOrder": [ "parent" ] }, "patch": { "id": "aiplatform.projects.locations.tensorboards.patch", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", "description": "Updates a Tensorboard.", "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1Tensorboard" }, "parameters": { "updateMask": { "type": "string", "description": "Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", "format": "google-fieldmask", "location": "query" }, "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "location": "path", "description": "Output only. Name of the Tensorboard. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "required": true } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH" } } }, "exampleStores": { "resources": { "operations": { "methods": { "list": { "id": "aiplatform.projects.locations.exampleStores.operations.list", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations", "parameters": { "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" }, "pageSize": { "format": "int32", "type": "integer", "description": "The standard list page size.", "location": "query" }, "name": { "description": "The name of the operation's parent resource.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", "type": "string" } }, "path": "v1beta1/{+name}/operations", "parameterOrder": [ "name" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "wait": { "httpMethod": "POST", "id": "aiplatform.projects.locations.exampleStores.operations.wait", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to wait on.", "location": "path", "required": true, "type": "string" }, "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "format": "google-duration", "type": "string" } }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:wait", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done." }, "cancel": { "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}:cancel", "path": "v1beta1/{+name}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$", "type": "string", "location": "path", "description": "The name of the operation resource to be cancelled.", "required": true } }, "id": "aiplatform.projects.locations.exampleStores.operations.cancel" }, "get": { "id": "aiplatform.projects.locations.exampleStores.operations.get", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$", "description": "The name of the operation resource.", "type": "string", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "path": "v1beta1/{+name}" }, "delete": { "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be deleted.", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.exampleStores.operations.delete" } } } }, "methods": { "get": { "id": "aiplatform.projects.locations.exampleStores.get", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleCloudAiplatformV1beta1ExampleStore" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}", "parameters": { "name": { "required": true, "description": "Required. The resource name of the ExampleStore. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", "type": "string" } }, "httpMethod": "GET", "description": "Get an ExampleStore.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "create": { "path": "v1beta1/{+parent}/exampleStores:create", "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores:create", "parameters": { "exampleStore.createTime": { "location": "query", "description": "Output only. Timestamp when this ExampleStore was created.", "format": "google-datetime", "type": "string" }, "exampleStore.displayName": { "type": "string", "description": "Required. Display name of the ExampleStore.", "location": "query" }, "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "description": "Required. The resource name of the Location to create the ExampleStore in. Format: `projects/{project}/locations/{location}`", "location": "path" }, "exampleStore.description": { "location": "query", "description": "Optional. Description of the ExampleStore.", "type": "string" }, "exampleStore.name": { "type": "string", "description": "Identifier. The resource name of the ExampleStore. This is a unique identifier. Format: projects/{project}/locations/{location}/exampleStores/{example_store}", "location": "query" }, "exampleStore.exampleStoreConfig.vertexEmbeddingModel": { "type": "string", "location": "query", "description": "Required. The embedding model to be used for vector embedding. Immutable. Supported models: * \"text-embedding-005\" * \"text-multilingual-embedding-002\"" }, "exampleStore.updateTime": { "description": "Output only. Timestamp when this ExampleStore was most recently updated.", "location": "query", "format": "google-datetime", "type": "string" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.exampleStores.create", "parameterOrder": [ "parent" ], "description": "Create an ExampleStore.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "updateMask": { "type": "string", "format": "google-fieldmask", "location": "query", "description": "Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description`" }, "name": { "required": true, "type": "string", "location": "path", "description": "Identifier. The resource name of the ExampleStore. This is a unique identifier. Format: projects/{project}/locations/{location}/exampleStores/{example_store}", "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$" } }, "httpMethod": "PATCH", "id": "aiplatform.projects.locations.exampleStores.patch", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Update an ExampleStore.", "path": "v1beta1/{+name}", "request": { "$ref": "GoogleCloudAiplatformV1beta1ExampleStore" } }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The resource name of the ExampleStore to be deleted. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", "type": "string", "required": true } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}", "id": "aiplatform.projects.locations.exampleStores.delete", "httpMethod": "DELETE", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Delete an ExampleStore.", "path": "v1beta1/{+name}" }, "removeExamples": { "id": "aiplatform.projects.locations.exampleStores.removeExamples", "description": "Remove Examples from the Example Store.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "exampleStore" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:removeExamples", "response": { "$ref": "GoogleCloudAiplatformV1beta1RemoveExamplesResponse" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1RemoveExamplesRequest" }, "parameters": { "exampleStore": { "location": "path", "description": "Required. The name of the ExampleStore resource that the examples should be removed from. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$" } }, "path": "v1beta1/{+exampleStore}:removeExamples", "httpMethod": "POST" }, "list": { "httpMethod": "GET", "path": "v1beta1/{+parent}/exampleStores", "parameters": { "pageSize": { "location": "query", "type": "integer", "description": "Optional. The standard list page size.", "format": "int32" }, "pageToken": { "type": "string", "description": "Optional. The standard list page token.", "location": "query" }, "parent": { "description": "Required. The resource name of the Location to list the ExampleStores from. Format: `projects/{project}/locations/{location}`", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true }, "filter": { "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores", "description": "List ExampleStores in a Location.", "parameterOrder": [ "parent" ], "id": "aiplatform.projects.locations.exampleStores.list", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListExampleStoresResponse" } }, "searchExamples": { "path": "v1beta1/{+exampleStore}:searchExamples", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:searchExamples", "parameters": { "exampleStore": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the ExampleStore resource that examples are retrieved from. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`" } }, "httpMethod": "POST", "id": "aiplatform.projects.locations.exampleStores.searchExamples", "response": { "$ref": "GoogleCloudAiplatformV1beta1SearchExamplesResponse" }, "parameterOrder": [ "exampleStore" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1SearchExamplesRequest" }, "description": "Search for similar Examples for given selection criteria.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "fetchExamples": { "parameterOrder": [ "exampleStore" ], "httpMethod": "POST", "parameters": { "exampleStore": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", "description": "Required. The name of the ExampleStore resource that the examples should be fetched from. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`", "required": true } }, "description": "Get Examples from the Example Store.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:fetchExamples", "request": { "$ref": "GoogleCloudAiplatformV1beta1FetchExamplesRequest" }, "response": { "$ref": "GoogleCloudAiplatformV1beta1FetchExamplesResponse" }, "id": "aiplatform.projects.locations.exampleStores.fetchExamples", "path": "v1beta1/{+exampleStore}:fetchExamples" }, "upsertExamples": { "description": "Create or update Examples in the Example Store.", "parameterOrder": [ "exampleStore" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1UpsertExamplesRequest" }, "response": { "$ref": "GoogleCloudAiplatformV1beta1UpsertExamplesResponse" }, "parameters": { "exampleStore": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", "description": "Required. The name of the ExampleStore resource that examples are added to or updated in. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`" } }, "id": "aiplatform.projects.locations.exampleStores.upsertExamples", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+exampleStore}:upsertExamples", "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:upsertExamples" } } }, "models": { "methods": { "deleteVersion": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.models.deleteVersion", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "type": "string", "required": true, "description": "Required. The name of the model version to be deleted, with a version ID explicitly included. Example: `projects/{project}/locations/{location}/models/{model}@1234`", "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", "location": "path" } }, "httpMethod": "DELETE", "description": "Deletes a Model version. Model version can only be deleted if there are no DeployedModels created from it. Deleting the only version in the Model is not allowed. Use DeleteModel for deleting the Model instead.", "path": "v1beta1/{+name}:deleteVersion", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:deleteVersion" }, "mergeVersionAliases": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:mergeVersionAliases", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.models.mergeVersionAliases", "description": "Merges a set of aliases for a Model version.", "path": "v1beta1/{+name}:mergeVersionAliases", "parameters": { "name": { "location": "path", "type": "string", "required": true, "description": "Required. The name of the model version to merge aliases, with a version ID explicitly included. Example: `projects/{project}/locations/{location}/models/{model}@1234`", "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1Model" }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1MergeVersionAliasesRequest" } }, "list": { "description": "Lists Models in a Location.", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1ListModelsResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models", "parameters": { "filter": { "location": "query", "description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `base_model_name` only supports = Some examples: * `model=1234` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`", "type": "string" }, "pageToken": { "location": "query", "description": "The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call.", "type": "string" }, "parent": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The resource name of the Location to list the Models from. Format: `projects/{project}/locations/{location}`" }, "readMask": { "type": "string", "format": "google-fieldmask", "location": "query", "description": "Mask specifying which fields to read." }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "The standard list page size." } }, "httpMethod": "GET", "path": "v1beta1/{+parent}/models", "id": "aiplatform.projects.locations.models.list", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "getIamPolicy": { "parameterOrder": [ "resource" ], "path": "v1beta1/{+resource}:getIamPolicy", "id": "aiplatform.projects.locations.models.getIamPolicy", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:getIamPolicy", "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "parameters": { "resource": { "type": "string", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", "required": true }, "options.requestedPolicyVersion": { "format": "int32", "type": "integer", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleIamV1Policy" }, "httpMethod": "POST" }, "listVersions": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listVersions", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1ListModelVersionsResponse" }, "parameterOrder": [ "name" ], "description": "Lists versions of the specified model.", "id": "aiplatform.projects.locations.models.listVersions", "httpMethod": "GET", "path": "v1beta1/{+name}:listVersions", "parameters": { "pageSize": { "description": "The standard list page size.", "format": "int32", "type": "integer", "location": "query" }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call." }, "orderBy": { "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `update_time asc, create_time desc`.", "type": "string", "location": "query" }, "readMask": { "format": "google-fieldmask", "location": "query", "description": "Mask specifying which fields to read.", "type": "string" }, "name": { "type": "string", "description": "Required. The name of the model to list versions for.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", "required": true }, "filter": { "description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `labels.myKey=\"myValue\"`", "type": "string", "location": "query" } } }, "upload": { "description": "Uploads a Model artifact into Vertex AI.", "request": { "$ref": "GoogleCloudAiplatformV1beta1UploadModelRequest" }, "httpMethod": "POST", "parameters": { "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The resource name of the Location into which to upload the Model. Format: `projects/{project}/locations/{location}`" } }, "path": "v1beta1/{+parent}/models:upload", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.models.upload", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models:upload" }, "testIamPermissions": { "path": "v1beta1/{+resource}:testIamPermissions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "id": "aiplatform.projects.locations.models.testIamPermissions", "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:testIamPermissions", "parameterOrder": [ "resource" ], "parameters": { "permissions": { "type": "string", "repeated": true, "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", "location": "query" }, "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "required": true, "location": "path", "type": "string" } } }, "delete": { "id": "aiplatform.projects.locations.models.delete", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Deletes a Model. A model cannot be deleted if any Endpoint resource has a DeployedModel based on the model in its deployed_models field.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}", "parameters": { "name": { "required": true, "location": "path", "description": "Required. The name of the Model resource to be deleted. Format: `projects/{project}/locations/{location}/models/{model}`", "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}" }, "copy": { "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1CopyModelRequest" }, "parameters": { "parent": { "type": "string", "description": "Required. The resource name of the Location into which to copy the Model. Format: `projects/{project}/locations/{location}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true } }, "path": "v1beta1/{+parent}/models:copy", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "id": "aiplatform.projects.locations.models.copy", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models:copy", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for Model.metadata content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible." }, "listCheckpoints": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listCheckpoints", "parameters": { "name": { "description": "Required. The name of the model version to list checkpoints for. `projects/{project}/locations/{location}/models/{model}@{version}` Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the latest version will be used.", "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", "location": "path", "type": "string", "required": true }, "pageSize": { "location": "query", "type": "integer", "description": "Optional. The standard list page size.", "format": "int32" }, "pageToken": { "description": "Optional. The standard list page token. Typically obtained via next_page_token of the previous ListModelVersionCheckpoints call.", "location": "query", "type": "string" } }, "id": "aiplatform.projects.locations.models.listCheckpoints", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListModelVersionCheckpointsResponse" }, "httpMethod": "GET", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:listCheckpoints", "description": "Lists checkpoints of the specified model version." }, "patch": { "path": "v1beta1/{+name}", "description": "Updates a Model.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1Model" }, "parameters": { "name": { "description": "Identifier. The resource name of the Model.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", "location": "path", "type": "string" }, "updateMask": { "location": "query", "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.", "type": "string", "format": "google-fieldmask" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1Model" }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.models.patch", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}" }, "get": { "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1Model" }, "description": "Gets a Model.", "httpMethod": "GET", "id": "aiplatform.projects.locations.models.get", "parameters": { "name": { "description": "Required. The name of the Model resource. Format: `projects/{project}/locations/{location}/models/{model}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the \"default\" version will be returned. The \"default\" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", "type": "string" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}", "parameterOrder": [ "name" ] }, "setIamPolicy": { "response": { "$ref": "GoogleIamV1Policy" }, "parameters": { "resource": { "required": true, "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "path": "v1beta1/{+resource}:setIamPolicy", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:setIamPolicy", "parameterOrder": [ "resource" ], "id": "aiplatform.projects.locations.models.setIamPolicy", "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" } }, "updateExplanationDataset": { "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:updateExplanationDataset", "description": "Incrementally update the dataset used for an examples model.", "id": "aiplatform.projects.locations.models.updateExplanationDataset", "request": { "$ref": "GoogleCloudAiplatformV1beta1UpdateExplanationDatasetRequest" }, "parameters": { "model": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", "description": "Required. The resource name of the Model to update. Format: `projects/{project}/locations/{location}/models/{model}`" } }, "parameterOrder": [ "model" ], "httpMethod": "POST", "path": "v1beta1/{+model}:updateExplanationDataset" }, "export": { "id": "aiplatform.projects.locations.models.export", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:export", "description": "Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one supported export format.", "parameters": { "name": { "location": "path", "required": true, "description": "Required. The resource name of the Model to export. The resource name may contain version id or version alias to specify the version, if no version is specified, the default version will be exported.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$" } }, "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1ExportModelRequest" }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:export", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "evaluations": { "methods": { "list": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations", "path": "v1beta1/{+parent}/evaluations", "description": "Lists ModelEvaluations in a Model.", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListModelEvaluationsResponse" }, "parameters": { "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "readMask": { "type": "string", "description": "Mask specifying which fields to read.", "location": "query", "format": "google-fieldmask" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", "required": true, "description": "Required. The resource name of the Model to list the ModelEvaluations from. Format: `projects/{project}/locations/{location}/models/{model}`", "type": "string", "location": "path" }, "pageToken": { "description": "The standard list page token. Typically obtained via ListModelEvaluationsResponse.next_page_token of the previous ModelService.ListModelEvaluations call.", "type": "string", "location": "query" }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "The standard list page size." } }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "id": "aiplatform.projects.locations.models.evaluations.list", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}", "id": "aiplatform.projects.locations.models.evaluations.get", "parameters": { "name": { "description": "Required. The name of the ModelEvaluation resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1ModelEvaluation" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "description": "Gets a ModelEvaluation." }, "import": { "id": "aiplatform.projects.locations.models.evaluations.import", "httpMethod": "POST", "path": "v1beta1/{+parent}/evaluations:import", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", "location": "path", "type": "string", "description": "Required. The name of the parent model resource. Format: `projects/{project}/locations/{location}/models/{model}`", "required": true } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1ImportModelEvaluationRequest" }, "response": { "$ref": "GoogleCloudAiplatformV1beta1ModelEvaluation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations:import", "description": "Imports an externally generated ModelEvaluation." } }, "resources": { "slices": { "methods": { "batchImport": { "response": { "$ref": "GoogleCloudAiplatformV1beta1BatchImportEvaluatedAnnotationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}:batchImport", "id": "aiplatform.projects.locations.models.evaluations.slices.batchImport", "parameters": { "parent": { "description": "Required. The name of the parent ModelEvaluationSlice resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`", "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/slices/[^/]+$", "required": true, "type": "string", "location": "path" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1BatchImportEvaluatedAnnotationsRequest" }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "description": "Imports a list of externally generated EvaluatedAnnotations.", "path": "v1beta1/{+parent}:batchImport" }, "list": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.models.evaluations.slices.list", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListModelEvaluationSlicesResponse" }, "path": "v1beta1/{+parent}/slices", "description": "Lists ModelEvaluationSlices in a ModelEvaluation.", "parameters": { "readMask": { "description": "Mask specifying which fields to read.", "format": "google-fieldmask", "type": "string", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token. Typically obtained via ListModelEvaluationSlicesResponse.next_page_token of the previous ModelService.ListModelEvaluationSlices call." }, "pageSize": { "description": "The standard list page size.", "type": "integer", "format": "int32", "location": "query" }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$", "required": true, "type": "string", "description": "Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices from. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`" }, "filter": { "type": "string", "description": "The standard list filter. * `slice.dimension` - for =.", "location": "query" } }, "parameterOrder": [ "parent" ], "httpMethod": "GET" }, "get": { "parameters": { "name": { "description": "Required. The name of the ModelEvaluationSlice resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/slices/[^/]+$", "location": "path" } }, "httpMethod": "GET", "id": "aiplatform.projects.locations.models.evaluations.slices.get", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets a ModelEvaluationSlice.", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleCloudAiplatformV1beta1ModelEvaluationSlice" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}" } } }, "operations": { "methods": { "cancel": { "httpMethod": "POST", "parameters": { "name": { "location": "path", "description": "The name of the operation resource to be cancelled.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel", "path": "v1beta1/{+name}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "id": "aiplatform.projects.locations.models.evaluations.operations.cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ] }, "list": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}/operations", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.models.evaluations.operations.list", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$", "type": "string", "location": "path", "required": true, "description": "The name of the operation's parent resource." }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "pageSize": { "format": "int32", "location": "query", "description": "The standard list page size.", "type": "integer" } } }, "wait": { "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameters": { "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "type": "string", "format": "google-duration" }, "name": { "required": true, "description": "The name of the operation resource to wait on.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$" } }, "id": "aiplatform.projects.locations.models.evaluations.operations.wait", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait", "path": "v1beta1/{+name}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "get": { "id": "aiplatform.projects.locations.models.evaluations.operations.get", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$", "required": true, "type": "string", "description": "The name of the operation resource.", "location": "path" } } }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.models.evaluations.operations.delete", "parameters": { "name": { "required": true, "description": "The name of the operation resource to be deleted.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$" } }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}" } } } } }, "operations": { "methods": { "get": { "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$" } }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.models.operations.get", "path": "v1beta1/{+name}" }, "cancel": { "path": "v1beta1/{+name}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:cancel", "id": "aiplatform.projects.locations.models.operations.cancel", "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be cancelled.", "location": "path" } } }, "delete": { "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.models.operations.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "location": "path", "type": "string", "required": true } }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "httpMethod": "DELETE" }, "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations", "parameterOrder": [ "name" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.models.operations.list", "path": "v1beta1/{+name}/operations", "parameters": { "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "pageSize": { "format": "int32", "description": "The standard list page size.", "location": "query", "type": "integer" }, "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", "required": true, "description": "The name of the operation's parent resource." } }, "httpMethod": "GET" }, "wait": { "id": "aiplatform.projects.locations.models.operations.wait", "path": "v1beta1/{+name}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:wait", "parameterOrder": [ "name" ], "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path", "description": "The name of the operation resource to wait on." }, "timeout": { "type": "string", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration" } } } } } } }, "trainingPipelines": { "methods": { "get": { "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "description": "Gets a TrainingPipeline.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.trainingPipelines.get", "response": { "$ref": "GoogleCloudAiplatformV1beta1TrainingPipeline" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", "location": "path", "type": "string", "description": "Required. The name of the TrainingPipeline resource. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", "required": true } } }, "delete": { "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.trainingPipelines.delete", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", "required": true, "location": "path", "description": "Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`" } }, "description": "Deletes a TrainingPipeline.", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "httpMethod": "DELETE" }, "list": { "description": "Lists TrainingPipelines in a Location.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines", "parameterOrder": [ "parent" ], "id": "aiplatform.projects.locations.trainingPipelines.list", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListTrainingPipelinesResponse" }, "path": "v1beta1/{+parent}/trainingPipelines", "httpMethod": "GET", "parameters": { "filter": { "type": "string", "location": "query", "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`\u003c`, `\u003c=`,`\u003e`, `\u003e=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"PIPELINE_STATE_SUCCEEDED\" AND display_name:\"my_pipeline_*\"` * `state!=\"PIPELINE_STATE_FAILED\" OR display_name=\"my_pipeline\"` * `NOT display_name=\"my_pipeline\"` * `create_time\u003e\"2021-05-18T00:00:00Z\"` * `training_task_definition:\"*automl_text_classification*\"`" }, "pageSize": { "format": "int32", "type": "integer", "description": "The standard list page size.", "location": "query" }, "readMask": { "type": "string", "location": "query", "description": "Mask specifying which fields to read.", "format": "google-fieldmask" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project}/locations/{location}`", "required": true, "type": "string" }, "pageToken": { "description": "The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call.", "type": "string", "location": "query" } } }, "cancel": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1CancelTrainingPipelineRequest" }, "path": "v1beta1/{+name}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "description": "Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`.", "id": "aiplatform.projects.locations.trainingPipelines.cancel", "httpMethod": "POST", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", "location": "path", "description": "Required. The name of the TrainingPipeline to cancel. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", "required": true, "type": "string" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}:cancel" }, "create": { "path": "v1beta1/{+parent}/trainingPipelines", "parameterOrder": [ "parent" ], "description": "Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.", "parameters": { "parent": { "type": "string", "location": "path", "required": true, "description": "Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project}/locations/{location}`", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines", "request": { "$ref": "GoogleCloudAiplatformV1beta1TrainingPipeline" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.trainingPipelines.create", "response": { "$ref": "GoogleCloudAiplatformV1beta1TrainingPipeline" } } }, "resources": { "operations": { "methods": { "list": { "path": "v1beta1/{+name}/operations", "id": "aiplatform.projects.locations.trainingPipelines.operations.list", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "The standard list page size." }, "name": { "required": true, "description": "The name of the operation's parent resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", "type": "string" }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "response": { "$ref": "GoogleLongrunningListOperationsResponse" } }, "delete": { "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.trainingPipelines.operations.delete", "path": "v1beta1/{+name}", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", "type": "string", "required": true, "description": "The name of the operation resource to be deleted." } }, "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "wait": { "id": "aiplatform.projects.locations.trainingPipelines.operations.wait", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:wait", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path", "description": "The name of the operation resource to wait on." }, "timeout": { "type": "string", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration" } }, "httpMethod": "POST" }, "cancel": { "httpMethod": "POST", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", "required": true, "location": "path", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.projects.locations.trainingPipelines.operations.cancel", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." }, "get": { "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource.", "location": "path" } }, "id": "aiplatform.projects.locations.trainingPipelines.operations.get", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", "parameterOrder": [ "name" ] } } } } }, "deploymentResourcePools": { "methods": { "get": { "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}", "description": "Get a DeploymentResourcePool.", "parameters": { "name": { "type": "string", "location": "path", "required": true, "description": "Required. The name of the DeploymentResourcePool to retrieve. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1DeploymentResourcePool" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.deploymentResourcePools.get" }, "queryDeployedModels": { "path": "v1beta1/{+deploymentResourcePool}:queryDeployedModels", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels", "parameterOrder": [ "deploymentResourcePool" ], "description": "List DeployedModels that have been deployed on this DeploymentResourcePool.", "httpMethod": "GET", "response": { "$ref": "GoogleCloudAiplatformV1beta1QueryDeployedModelsResponse" }, "parameters": { "pageSize": { "type": "integer", "description": "The maximum number of DeployedModels to return. The service may return fewer than this value.", "format": "int32", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "A page token, received from a previous `QueryDeployedModels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDeployedModels` must match the call that provided the page token." }, "deploymentResourcePool": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", "description": "Required. The name of the target DeploymentResourcePool to query. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", "required": true } }, "id": "aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "parameters": { "parent": { "location": "path", "description": "Required. The parent location resource where this DeploymentResourcePool will be created. Format: `projects/{project}/locations/{location}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "httpMethod": "POST", "description": "Create a DeploymentResourcePool.", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1CreateDeploymentResourcePoolRequest" }, "path": "v1beta1/{+parent}/deploymentResourcePools", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools", "id": "aiplatform.projects.locations.deploymentResourcePools.create", "response": { "$ref": "GoogleLongrunningOperation" } }, "list": { "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools", "parameters": { "parent": { "description": "Required. The parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true }, "pageToken": { "description": "A page token, received from a previous `ListDeploymentResourcePools` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeploymentResourcePools` must match the call that provided the page token.", "location": "query", "type": "string" }, "pageSize": { "location": "query", "description": "The maximum number of DeploymentResourcePools to return. The service may return fewer than this value.", "format": "int32", "type": "integer" } }, "description": "List DeploymentResourcePools in a location.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1ListDeploymentResourcePoolsResponse" }, "path": "v1beta1/{+parent}/deploymentResourcePools", "parameterOrder": [ "parent" ], "id": "aiplatform.projects.locations.deploymentResourcePools.list" }, "delete": { "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.deploymentResourcePools.delete", "httpMethod": "DELETE", "path": "v1beta1/{+name}", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", "required": true, "description": "Required. The name of the DeploymentResourcePool to delete. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", "location": "path" } }, "description": "Delete a DeploymentResourcePool.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" } }, "patch": { "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "description": "Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", "required": true, "type": "string", "location": "path" }, "updateMask": { "type": "string", "location": "query", "format": "google-fieldmask", "description": "Required. The list of fields to update." } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1DeploymentResourcePool" }, "httpMethod": "PATCH", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.deploymentResourcePools.patch", "path": "v1beta1/{+name}", "description": "Update a DeploymentResourcePool." } }, "resources": { "operations": { "methods": { "delete": { "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.deploymentResourcePools.operations.delete", "httpMethod": "DELETE", "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation resource to be deleted.", "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$", "location": "path" } }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." }, "list": { "path": "v1beta1/{+name}/operations", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", "location": "path", "description": "The name of the operation's parent resource.", "required": true }, "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "pageSize": { "type": "integer", "description": "The standard list page size.", "location": "query", "format": "int32" }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations", "id": "aiplatform.projects.locations.deploymentResourcePools.operations.list", "response": { "$ref": "GoogleLongrunningListOperationsResponse" } }, "get": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}", "id": "aiplatform.projects.locations.deploymentResourcePools.operations.get", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}", "parameters": { "name": { "location": "path", "description": "The name of the operation resource.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$" } }, "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET" }, "wait": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "type": "string", "required": true, "description": "The name of the operation resource to wait on.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$" }, "timeout": { "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "format": "google-duration" } }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "httpMethod": "POST", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait", "id": "aiplatform.projects.locations.deploymentResourcePools.operations.wait", "path": "v1beta1/{+name}:wait" }, "cancel": { "httpMethod": "POST", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$", "type": "string", "required": true, "description": "The name of the operation resource to be cancelled.", "location": "path" } }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "id": "aiplatform.projects.locations.deploymentResourcePools.operations.cancel", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel" } } } } }, "notebookRuntimeTemplates": { "resources": { "operations": { "methods": { "cancel": { "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "POST", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "type": "string", "location": "path", "description": "The name of the operation resource to be cancelled.", "required": true } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:cancel", "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.cancel", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel" }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.list", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameters": { "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "The standard list page size." }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "name": { "type": "string", "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", "location": "path", "required": true }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" } }, "path": "v1beta1/{+name}/operations", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "path": "v1beta1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.get", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", "httpMethod": "GET" }, "delete": { "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.delete", "path": "v1beta1/{+name}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation resource to be deleted.", "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "location": "path" } }, "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "wait": { "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation resource to wait on.", "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "location": "path" }, "timeout": { "type": "string", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:wait", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait", "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.wait", "parameterOrder": [ "name" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done." } } } }, "methods": { "patch": { "id": "aiplatform.projects.locations.notebookRuntimeTemplates.patch", "description": "Updates a NotebookRuntimeTemplate.", "request": { "$ref": "GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate" }, "parameters": { "updateMask": { "location": "query", "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Input format: `{paths: \"${updated_field}\"}` Updatable fields: * `encryption_spec.kms_key_name` * `display_name` * `software_config.post_startup_script_config.post_startup_script` * `software_config.post_startup_script_config.post_startup_script_url` * `software_config.post_startup_script_config.post_startup_script_behavior` * `software_config.env` * `software_config.colab_image.release_name` * `software_config.custom_container_config.image_uri`", "type": "string", "format": "google-fieldmask" }, "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", "location": "path", "description": "The resource name of the NotebookRuntimeTemplate." } }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "response": { "$ref": "GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}" }, "delete": { "parameterOrder": [ "name" ], "description": "Deletes a NotebookRuntimeTemplate.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.notebookRuntimeTemplates.delete", "path": "v1beta1/{+name}", "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$" } } }, "setIamPolicy": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ], "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "id": "aiplatform.projects.locations.notebookRuntimeTemplates.setIamPolicy", "response": { "$ref": "GoogleIamV1Policy" }, "path": "v1beta1/{+resource}:setIamPolicy", "parameters": { "resource": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path" } }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:setIamPolicy" }, "create": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Creates a NotebookRuntimeTemplate.", "path": "v1beta1/{+parent}/notebookRuntimeTemplates", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path", "description": "Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project}/locations/{location}`", "type": "string" }, "notebookRuntimeTemplateId": { "type": "string", "description": "Optional. User specified ID for the notebook runtime template.", "location": "query" } }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "id": "aiplatform.projects.locations.notebookRuntimeTemplates.create", "request": { "$ref": "GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "parameterOrder": [ "name" ], "description": "Gets a NotebookRuntimeTemplate.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`", "location": "path" } }, "id": "aiplatform.projects.locations.notebookRuntimeTemplates.get", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "response": { "$ref": "GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}" }, "list": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates", "description": "Lists NotebookRuntimeTemplates in a Location.", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListNotebookRuntimeTemplatesResponse" }, "path": "v1beta1/{+parent}/notebookRuntimeTemplates", "httpMethod": "GET", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "location": "path", "required": true, "description": "Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project}/locations/{location}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "type": "string", "description": "Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call.", "location": "query" }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "Optional. The standard list page size." }, "filter": { "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4`", "type": "string", "location": "query" }, "readMask": { "description": "Optional. Mask specifying which fields to read.", "location": "query", "type": "string", "format": "google-fieldmask" }, "orderBy": { "location": "query", "type": "string", "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`." } }, "id": "aiplatform.projects.locations.notebookRuntimeTemplates.list" }, "getIamPolicy": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "parameterOrder": [ "resource" ], "parameters": { "resource": { "type": "string", "location": "path", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$" }, "options.requestedPolicyVersion": { "type": "integer", "location": "query", "format": "int32", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." } }, "path": "v1beta1/{+resource}:getIamPolicy", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:getIamPolicy", "id": "aiplatform.projects.locations.notebookRuntimeTemplates.getIamPolicy", "response": { "$ref": "GoogleIamV1Policy" } }, "testIamPermissions": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "httpMethod": "POST", "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "parameterOrder": [ "resource" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:testIamPermissions", "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", "location": "path" }, "permissions": { "repeated": true, "type": "string", "location": "query", "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions)." } }, "id": "aiplatform.projects.locations.notebookRuntimeTemplates.testIamPermissions", "path": "v1beta1/{+resource}:testIamPermissions" } } }, "onlineEvaluators": { "resources": { "operations": { "methods": { "cancel": { "id": "aiplatform.projects.locations.onlineEvaluators.operations.cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "path": "v1beta1/{+name}:cancel", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "required": true } }, "parameterOrder": [ "name" ] }, "get": { "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.onlineEvaluators.operations.get", "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource.", "type": "string", "location": "path" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}", "httpMethod": "GET", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "wait": { "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.onlineEvaluators.operations.wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameters": { "timeout": { "format": "google-duration", "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query" }, "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to wait on." } }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:wait", "path": "v1beta1/{+name}:wait" }, "list": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.onlineEvaluators.operations.list", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "pageSize": { "type": "integer", "description": "The standard list page size.", "format": "int32", "location": "query" }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "name": { "location": "path", "description": "The name of the operation's parent resource.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+$", "type": "string" } }, "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1beta1/{+name}/operations", "parameterOrder": [ "name" ] }, "delete": { "parameterOrder": [ "name" ], "httpMethod": "DELETE", "id": "aiplatform.projects.locations.onlineEvaluators.operations.delete", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "required": true, "type": "string", "location": "path" } }, "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." } } } }, "methods": { "suspend": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}:suspend", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Suspends an OnlineEvaluator. When an OnlineEvaluator is suspended, it won't run any evaluations until it is activated again.", "request": { "$ref": "GoogleCloudAiplatformV1beta1SuspendOnlineEvaluatorRequest" }, "parameters": { "name": { "description": "Required. The name of the OnlineEvaluator to suspend. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:suspend", "id": "aiplatform.projects.locations.onlineEvaluators.suspend", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "activate": { "id": "aiplatform.projects.locations.onlineEvaluators.activate", "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1ActivateOnlineEvaluatorRequest" }, "path": "v1beta1/{+name}:activate", "parameters": { "name": { "required": true, "description": "Required. The name of the OnlineEvaluator to activate. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+$" } }, "description": "Activates an OnlineEvaluator.", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}:activate" }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.onlineEvaluators.list", "path": "v1beta1/{+parent}/onlineEvaluators", "httpMethod": "GET", "parameters": { "orderBy": { "type": "string", "location": "query", "description": "Optional. A comma-separated list of fields to order by. The default sorting order is ascending. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`. Based on aip.dev/132." }, "parent": { "required": true, "type": "string", "description": "Required. The parent resource of the OnlineEvaluators to list. Format: projects/{project}/locations/{location}.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "filter": { "description": "Optional. Standard list filter. Supported fields: * `create_time` * `update_time` * `agent_resource` Example: `create_time\u003e\"2026-01-01T00:00:00-04:00\"` where the timestamp is in RFC 3339 format) Based on aip.dev/160.", "location": "query", "type": "string" }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "Optional. The maximum number of OnlineEvaluators to return. The service may return fewer than this value. If unspecified, at most 100 OnlineEvaluators will be returned. The maximum value is 100; values above 100 will be coerced to 100. Based on aip.dev/158." }, "pageToken": { "type": "string", "location": "query", "description": "Optional. A token identifying a page of results the server should return. Based on aip.dev/158." } }, "parameterOrder": [ "parent" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators", "description": "Lists the OnlineEvaluators for the given project and location.", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListOnlineEvaluatorsResponse" } }, "patch": { "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluator" }, "httpMethod": "PATCH", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "required": true, "description": "Identifier. The resource name of the OnlineEvaluator. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.", "pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+$", "type": "string" }, "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated." } }, "id": "aiplatform.projects.locations.onlineEvaluators.patch", "description": "Updates the fields of an OnlineEvaluator.", "path": "v1beta1/{+name}" }, "get": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluator" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+$", "location": "path", "description": "Required. The name of the OnlineEvaluator to retrieve. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.", "type": "string", "required": true } }, "description": "Gets details of an OnlineEvaluator.", "id": "aiplatform.projects.locations.onlineEvaluators.get", "path": "v1beta1/{+name}" }, "delete": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}", "path": "v1beta1/{+name}", "description": "Deletes an OnlineEvaluator.", "id": "aiplatform.projects.locations.onlineEvaluators.delete", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+$", "location": "path", "required": true, "description": "Required. The name of the OnlineEvaluator to delete. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.", "type": "string" } }, "parameterOrder": [ "name" ], "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "parameters": { "parent": { "type": "string", "required": true, "description": "Required. The parent resource where the OnlineEvaluator will be created. Format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" } }, "id": "aiplatform.projects.locations.onlineEvaluators.create", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "description": "Creates an OnlineEvaluator in the given project and location.", "path": "v1beta1/{+parent}/onlineEvaluators", "request": { "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluator" }, "parameterOrder": [ "parent" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "notebookExecutionJobs": { "methods": { "generateAccessToken": { "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.notebookExecutionJobs.generateAccessToken", "path": "v1beta1/{+name}:generateAccessToken", "description": "Internal only: Called from Compute Engine instance to obtain EUC for owner Anonymous access: authenticates caller using VM identity JWT. Design doc: go/colab-on-vertex-euc-dd", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", "location": "path", "type": "string", "required": true, "description": "Required. The name of the resource requesting the OAuth2 token. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}` `projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_job}`" } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}:generateAccessToken" }, "create": { "id": "aiplatform.projects.locations.notebookExecutionJobs.create", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "description": "Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`", "location": "path" }, "notebookExecutionJobId": { "description": "Optional. User specified ID for the NotebookExecutionJob.", "type": "string", "location": "query" } }, "description": "Creates a NotebookExecutionJob.", "request": { "$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJob" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs", "httpMethod": "POST", "path": "v1beta1/{+parent}/notebookExecutionJobs", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "reportEvent": { "request": { "$ref": "GoogleCloudAiplatformV1beta1ReportExecutionEventRequest" }, "parameterOrder": [ "name" ], "description": "", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}:reportEvent", "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the NotebookExecutionJob resource. Format: `projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_jobs}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$" } }, "id": "aiplatform.projects.locations.notebookExecutionJobs.reportEvent", "path": "v1beta1/{+name}:reportEvent", "response": { "$ref": "GoogleCloudAiplatformV1beta1ReportExecutionEventResponse" } }, "list": { "description": "Lists NotebookExecutionJobs in a Location.", "parameters": { "view": { "enum": [ "NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED", "NOTEBOOK_EXECUTION_JOB_VIEW_BASIC", "NOTEBOOK_EXECUTION_JOB_VIEW_FULL" ], "enumDescriptions": [ "When unspecified, the API defaults to the BASIC view.", "Includes all fields except for direct notebook inputs.", "Includes all fields." ], "description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.", "type": "string", "location": "query" }, "filter": { "type": "string", "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob=\"123\"` * `notebookExecutionJob=\"my-execution-job\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"`", "location": "query" }, "pageSize": { "description": "Optional. The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "orderBy": { "location": "query", "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", "type": "string" }, "parent": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project}/locations/{location}`" }, "pageToken": { "type": "string", "description": "Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobsResponse.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call.", "location": "query" } }, "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/notebookExecutionJobs", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.notebookExecutionJobs.list", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListNotebookExecutionJobsResponse" } }, "delete": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", "description": "Required. The name of the NotebookExecutionJob resource to be deleted." } }, "httpMethod": "DELETE", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.notebookExecutionJobs.delete", "description": "Deletes a NotebookExecutionJob.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}" }, "get": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}", "description": "Gets a NotebookExecutionJob.", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJob" }, "id": "aiplatform.projects.locations.notebookExecutionJobs.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", "required": true, "type": "string", "description": "Required. The name of the NotebookExecutionJob resource.", "location": "path" }, "view": { "type": "string", "enum": [ "NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED", "NOTEBOOK_EXECUTION_JOB_VIEW_BASIC", "NOTEBOOK_EXECUTION_JOB_VIEW_FULL" ], "description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.", "enumDescriptions": [ "When unspecified, the API defaults to the BASIC view.", "Includes all fields except for direct notebook inputs.", "Includes all fields." ], "location": "query" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}" } }, "resources": { "operations": { "methods": { "delete": { "parameters": { "name": { "location": "path", "type": "string", "description": "The name of the operation resource to be deleted.", "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$", "required": true } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.notebookExecutionJobs.operations.delete", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." }, "get": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.notebookExecutionJobs.operations.get", "path": "v1beta1/{+name}", "httpMethod": "GET", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "description": "The name of the operation resource.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}" }, "wait": { "httpMethod": "POST", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameters": { "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration", "location": "query", "type": "string" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to wait on.", "location": "path", "type": "string", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}:wait", "id": "aiplatform.projects.locations.notebookExecutionJobs.operations.wait" }, "list": { "httpMethod": "GET", "path": "v1beta1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.notebookExecutionJobs.operations.list", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations", "parameters": { "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", "description": "The name of the operation's parent resource.", "required": true, "type": "string" } }, "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ] }, "cancel": { "id": "aiplatform.projects.locations.notebookExecutionJobs.operations.cancel", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:cancel", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be cancelled.", "type": "string", "required": true } } } } } } }, "skills": { "methods": { "get": { "httpMethod": "GET", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+$", "type": "string", "location": "path", "description": "Required. The resource name of the Skill to retrieve. Format: `projects/{project}/locations/{location}/skills/{skill}`" } }, "description": "Get a Skill.", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.skills.get", "response": { "$ref": "GoogleCloudAiplatformV1beta1Skill" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.skills.delete", "description": "Delete a Skill.", "parameters": { "name": { "description": "Required. The resource name of the Skill to delete. Format: `projects/{project}/locations/{location}/skills/{skill}`", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+$" } }, "httpMethod": "DELETE", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}" }, "list": { "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "location": "query", "description": "Optional. The standard list page size.", "type": "integer", "format": "int32" }, "parent": { "required": true, "description": "Required. The location to list the Skills in. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The standard list page token." } }, "httpMethod": "GET", "path": "v1beta1/{+parent}/skills", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1ListSkillsResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills", "description": "List Skills.", "id": "aiplatform.projects.locations.skills.list" }, "retrieve": { "httpMethod": "GET", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "type": "string", "description": "Required. The location to retrieve the Skills in. Format: `projects/{project}/locations/{location}`", "required": true }, "topK": { "location": "query", "description": "Optional. The maximum number of skills to return. The service may return fewer than this value. If unspecified, at most 10 skills will be returned. The maximum value is 100.", "type": "integer", "format": "int32" }, "query": { "description": "Optional. The query to find matching skills.", "location": "query", "type": "string" } }, "description": "Retrieves skills.", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1RetrieveSkillsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.skills.retrieve", "path": "v1beta1/{+parent}/skills:retrieve", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills:retrieve" }, "patch": { "id": "aiplatform.projects.locations.skills.patch", "parameters": { "updateMask": { "description": "Optional. Mask specifying which fields to update.", "type": "string", "format": "google-fieldmask", "location": "query" }, "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+$", "type": "string", "location": "path", "description": "Identifier. The resource name of the Skill. Format: `projects/{project}/locations/{location}/skills/{skill}`" } }, "httpMethod": "PATCH", "request": { "$ref": "GoogleCloudAiplatformV1beta1Skill" }, "description": "Update a Skill.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}" }, "create": { "parameters": { "skillId": { "description": "Required. The ID to use for the Skill, which will become the final component of the Skill's resource name. If not provided, a system-generated ID will be used. This value must be 1-63 characters. Valid characters are lowercase letters, numbers, and hyphens. The first character must be a lowercase letter, and the last character must be a lowercase letter or a number. Specifically, the ID must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$` See [AIP-122](https://aip.dev/122#resource-id-segments) for more details.", "type": "string", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The location to create the Skill in. Format: `projects/{project}/locations/{location}`", "type": "string", "required": true } }, "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+parent}/skills", "httpMethod": "POST", "description": "Create a Skill.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.skills.create", "request": { "$ref": "GoogleCloudAiplatformV1beta1Skill" } } }, "resources": { "revisions": { "methods": { "get": { "response": { "$ref": "GoogleCloudAiplatformV1beta1SkillRevision" }, "id": "aiplatform.projects.locations.skills.revisions.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/revisions/{revisionsId}", "description": "Get a Skill Revision.", "httpMethod": "GET", "path": "v1beta1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+/revisions/[^/]+$", "required": true, "description": "Required. The resource name of the Skill Revision to retrieve. Format: `projects/{project}/locations/{location}/skills/{skill}/revisions/{revision}`", "location": "path", "type": "string" } } }, "list": { "response": { "$ref": "GoogleCloudAiplatformV1beta1ListSkillRevisionsResponse" }, "id": "aiplatform.projects.locations.skills.revisions.list", "path": "v1beta1/{+parent}/revisions", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/revisions", "httpMethod": "GET", "description": "List Skill Revisions for a Skill.", "parameters": { "pageSize": { "format": "int32", "description": "Optional. The standard list page size.", "location": "query", "type": "integer" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+$", "required": true, "type": "string", "description": "Required. The resource name of the Skill to list revisions for. Format: `projects/{project}/locations/{location}/skills/{skill}`", "location": "path" }, "filter": { "type": "string", "location": "query", "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels`" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The standard list page token." } }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "operations": { "methods": { "list": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/operations", "path": "v1beta1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.skills.operations.list", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+$", "required": true, "type": "string" }, "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "pageSize": { "location": "query", "type": "integer", "description": "The standard list page size.", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" } }, "httpMethod": "GET" }, "get": { "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.skills.operations.get", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+/operations/[^/]+$", "description": "The name of the operation resource.", "location": "path", "type": "string", "required": true } }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "wait": { "id": "aiplatform.projects.locations.skills.operations.wait", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:wait", "httpMethod": "POST", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameters": { "timeout": { "format": "google-duration", "type": "string", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." }, "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource to wait on." } }, "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/operations/{operationsId}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "cancel": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.projects.locations.skills.operations.cancel", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:cancel", "parameterOrder": [ "name" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." }, "delete": { "id": "aiplatform.projects.locations.skills.operations.delete", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/skills/[^/]+/operations/[^/]+$", "required": true, "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/operations/{operationsId}", "parameterOrder": [ "name" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "response": { "$ref": "GoogleProtobufEmpty" } } } } } }, "interactionsHttp": { "methods": { "get": { "parameterOrder": [ "name" ], "description": "Gets an interaction.", "response": { "$ref": "GoogleApiHttpBody" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactionsHttp/{interactionsHttpId}", "id": "aiplatform.projects.locations.interactionsHttp.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "required": true, "description": "Required. The name of the interaction to retrieve. Format: interactions/{interaction}", "pattern": "^projects/[^/]+/locations/[^/]+/interactionsHttp/[^/]+$", "location": "path" }, "lastEventId": { "type": "string", "description": "If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if `stream` is true.", "location": "query" }, "includeInput": { "location": "query", "type": "boolean", "deprecated": true, "description": "If true, includes the input in the response." }, "stream": { "location": "query", "description": "If true, streams the interaction events as Server-Sent Events.", "type": "boolean" } }, "httpMethod": "GET", "path": "v1beta1/{+name}" }, "create": { "httpMethod": "POST", "response": { "$ref": "GoogleApiHttpBody" }, "parameters": { "parent": { "type": "string", "location": "path", "description": "Required. The parent resource where this interaction will be created. Format: `projects/{project}/locations/{location}` Supported only by the Vertex API only.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactionsHttp", "description": "Generates a set of responses from the model.", "id": "aiplatform.projects.locations.interactionsHttp.create", "request": { "$ref": "GenaiVertexV1beta1CreateInteractionHttpRequest" }, "path": "v1beta1/{+parent}/interactionsHttp", "parameterOrder": [ "parent" ] }, "cancel": { "path": "v1beta1/{+name}/cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.interactionsHttp.cancel", "description": "Cancels an interaction.", "response": { "$ref": "GoogleApiHttpBody" }, "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/interactionsHttp/[^/]+$", "description": "Required. The name of the interaction to cancel. Format: `interactions/{interaction}`." } }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactionsHttp/{interactionsHttpId}/cancel" } } }, "migratableResources": { "methods": { "search": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources:search", "response": { "$ref": "GoogleCloudAiplatformV1beta1SearchMigratableResourcesResponse" }, "path": "v1beta1/{+parent}/migratableResources:search", "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The location that the migratable resources should be searched from. It's the Vertex AI location that the resources can be migrated to, not the resources' original location. Format: `projects/{project}/locations/{location}`", "type": "string" } }, "id": "aiplatform.projects.locations.migratableResources.search", "description": "Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.", "request": { "$ref": "GoogleCloudAiplatformV1beta1SearchMigratableResourcesRequest" } }, "batchMigrate": { "path": "v1beta1/{+parent}/migratableResources:batchMigrate", "request": { "$ref": "GoogleCloudAiplatformV1beta1BatchMigrateResourcesRequest" }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "parameters": { "parent": { "location": "path", "type": "string", "description": "Required. The location of the migrated resource will live in. Format: `projects/{project}/locations/{location}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "id": "aiplatform.projects.locations.migratableResources.batchMigrate", "description": "Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources:batchMigrate" } }, "resources": { "operations": { "methods": { "delete": { "id": "aiplatform.projects.locations.migratableResources.operations.delete", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "description": "The name of the operation resource to be deleted.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "httpMethod": "DELETE", "path": "v1beta1/{+name}" }, "list": { "httpMethod": "GET", "parameters": { "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "name": { "description": "The name of the operation's parent resource.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+$" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "pageSize": { "description": "The standard list page size.", "format": "int32", "type": "integer", "location": "query" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" } }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.migratableResources.operations.list", "path": "v1beta1/{+name}/operations", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations" }, "cancel": { "httpMethod": "POST", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$", "required": true, "location": "path", "type": "string" } }, "path": "v1beta1/{+name}:cancel", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel", "id": "aiplatform.projects.locations.migratableResources.operations.cancel" }, "get": { "id": "aiplatform.projects.locations.migratableResources.operations.get", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}", "parameters": { "name": { "description": "The name of the operation resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "path": "v1beta1/{+name}" }, "wait": { "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.migratableResources.operations.wait", "parameters": { "timeout": { "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "format": "google-duration" }, "name": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to wait on." } }, "httpMethod": "POST", "path": "v1beta1/{+name}:wait" } } } } }, "ragCorpora": { "methods": { "get": { "response": { "$ref": "GoogleCloudAiplatformV1beta1RagCorpus" }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}", "description": "Gets a RagCorpus.", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "required": true, "location": "path", "description": "Required. The name of the RagCorpus resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$" } }, "id": "aiplatform.projects.locations.ragCorpora.get", "path": "v1beta1/{+name}" }, "patch": { "id": "aiplatform.projects.locations.ragCorpora.patch", "path": "v1beta1/{+name}", "request": { "$ref": "GoogleCloudAiplatformV1beta1RagCorpus" }, "description": "Updates a RagCorpus.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", "description": "Output only. The resource name of the RagCorpus." } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}", "httpMethod": "PATCH" }, "delete": { "description": "Deletes a RagCorpus.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}", "id": "aiplatform.projects.locations.ragCorpora.delete", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "httpMethod": "DELETE", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "forceDelete": { "description": "Optional. If set to true, any errors generated by external vector database during the deletion will be ignored. The default value is false.", "type": "boolean", "location": "query" }, "name": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", "description": "Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", "location": "path" }, "force": { "type": "boolean", "description": "Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles.", "location": "query" } } }, "create": { "parameters": { "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project}/locations/{location}`", "location": "path", "type": "string" } }, "path": "v1beta1/{+parent}/ragCorpora", "httpMethod": "POST", "id": "aiplatform.projects.locations.ragCorpora.create", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "description": "Creates a RagCorpus.", "request": { "$ref": "GoogleCloudAiplatformV1beta1RagCorpus" }, "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora" }, "list": { "description": "Lists RagCorpora in a Location.", "path": "v1beta1/{+parent}/ragCorpora", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1ListRagCorporaResponse" }, "parameterOrder": [ "parent" ], "httpMethod": "GET", "id": "aiplatform.projects.locations.ragCorpora.list", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "description": "Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project}/locations/{location}`", "location": "path" }, "pageSize": { "format": "int32", "location": "query", "description": "Optional. The standard list page size. The maximum value is 100. If not specified, a default value of 100 will be used.", "type": "integer" }, "pageToken": { "type": "string", "description": "Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call.", "location": "query" } } } }, "resources": { "ragDataSchemas": { "methods": { "delete": { "description": "Deletes a RagDataSchema.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragDataSchemas/{ragDataSchemasId}", "id": "aiplatform.projects.locations.ragCorpora.ragDataSchemas.delete", "parameters": { "name": { "description": "Required. The name of the RagDataSchema resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}`", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragDataSchemas/[^/]+$" } }, "path": "v1beta1/{+name}" }, "list": { "response": { "$ref": "GoogleCloudAiplatformV1beta1ListRagDataSchemasResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragDataSchemas", "id": "aiplatform.projects.locations.ragCorpora.ragDataSchemas.list", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists RagDataSchemas in a Location.", "path": "v1beta1/{+parent}/ragDataSchemas", "parameters": { "pageSize": { "location": "query", "description": "Optional. The standard list page size. The maximum value is 100. If not specified, a default value of 100 will be used.", "format": "int32", "type": "integer" }, "pageToken": { "description": "Optional. The standard list page token. Typically obtained via ListRagDataSchemasResponse.next_page_token of the previous VertexRagDataService.ListRagDataSchemas call.", "location": "query", "type": "string" }, "parent": { "required": true, "description": "Required. The resource name of the RagCorpus from which to list the RagDataSchemas. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", "location": "path" } }, "parameterOrder": [ "parent" ], "httpMethod": "GET" }, "batchCreate": { "id": "aiplatform.projects.locations.ragCorpora.ragDataSchemas.batchCreate", "parameterOrder": [ "parent" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragDataSchemas:batchCreate", "path": "v1beta1/{+parent}/ragDataSchemas:batchCreate", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", "type": "string", "required": true, "description": "Required. The resource name of the RagCorpus to create the RagDataSchemas in. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", "location": "path" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1BatchCreateRagDataSchemasRequest" }, "httpMethod": "POST", "description": "Batch Create one or more RagDataSchemas", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragDataSchemas/{ragDataSchemasId}", "response": { "$ref": "GoogleCloudAiplatformV1beta1RagDataSchema" }, "httpMethod": "GET", "parameters": { "name": { "type": "string", "location": "path", "description": "Required. The name of the RagDataSchema resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}`", "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragDataSchemas/[^/]+$", "required": true } }, "id": "aiplatform.projects.locations.ragCorpora.ragDataSchemas.get", "parameterOrder": [ "name" ], "description": "Gets a RagDataSchema.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "batchDelete": { "parameters": { "parent": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", "description": "Required. The resource name of the RagCorpus from which to delete the RagDataSchemas. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+parent}/ragDataSchemas:batchDelete", "httpMethod": "POST", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragDataSchemas:batchDelete", "description": "Batch Deletes one or more RagDataSchemas", "request": { "$ref": "GoogleCloudAiplatformV1beta1BatchDeleteRagDataSchemasRequest" }, "id": "aiplatform.projects.locations.ragCorpora.ragDataSchemas.batchDelete" }, "create": { "path": "v1beta1/{+parent}/ragDataSchemas", "httpMethod": "POST", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The resource name of the RagCorpus to create the RagDataSchema in. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`" }, "ragDataSchemaId": { "location": "query", "description": "Optional. The ID to use for the RagDataSchema, which will become the final component of the RagDataSchema's resource name if the user chooses to specify. Otherwise, RagDataSchema id will be generated by system. This value should be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.", "type": "string" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragDataSchemas", "request": { "$ref": "GoogleCloudAiplatformV1beta1RagDataSchema" }, "description": "Creates a RagDataSchema.", "id": "aiplatform.projects.locations.ragCorpora.ragDataSchemas.create", "response": { "$ref": "GoogleCloudAiplatformV1beta1RagDataSchema" } } } }, "operations": { "methods": { "cancel": { "id": "aiplatform.projects.locations.ragCorpora.operations.cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$", "required": true, "type": "string", "description": "The name of the operation resource to be cancelled." } }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "httpMethod": "POST", "path": "v1beta1/{+name}:cancel", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ] }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.ragCorpora.operations.delete", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$", "required": true, "location": "path" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "list": { "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.ragCorpora.operations.list", "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v1beta1/{+name}/operations", "parameters": { "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "The standard list page size." }, "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", "description": "The name of the operation's parent resource.", "type": "string" }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" } }, "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations" }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.ragCorpora.operations.get", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}", "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$", "description": "The name of the operation resource." } } }, "wait": { "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$", "type": "string", "location": "path", "description": "The name of the operation resource to wait on.", "required": true }, "timeout": { "type": "string", "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query" } }, "parameterOrder": [ "name" ], "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}:wait", "id": "aiplatform.projects.locations.ragCorpora.operations.wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "path": "v1beta1/{+name}:wait" } } }, "ragFiles": { "methods": { "get": { "description": "Gets a RagFile.", "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.ragCorpora.ragFiles.get", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}", "response": { "$ref": "GoogleCloudAiplatformV1beta1RagFile" }, "httpMethod": "GET", "parameters": { "name": { "location": "path", "description": "Required. The name of the RagFile resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$", "type": "string" } } }, "import": { "request": { "$ref": "GoogleCloudAiplatformV1beta1ImportRagFilesRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:import", "description": "Import files from Google Cloud Storage or Google Drive into a RagCorpus.", "id": "aiplatform.projects.locations.ragCorpora.ragFiles.import", "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", "type": "string", "location": "path", "description": "Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", "required": true } }, "httpMethod": "POST", "path": "v1beta1/{+parent}/ragFiles:import", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "id": "aiplatform.projects.locations.ragCorpora.ragFiles.list", "httpMethod": "GET", "path": "v1beta1/{+parent}/ragFiles", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageSize": { "format": "int32", "type": "integer", "location": "query", "description": "Optional. The standard list page size. The maximum value is 100. If not specified, a default value of 100 will be used." }, "parent": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", "description": "Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", "location": "path" }, "pageToken": { "description": "Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1ListRagFilesResponse" }, "description": "Lists RagFiles in a RagCorpus.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles" }, "delete": { "description": "Deletes a RagFile.", "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.ragCorpora.ragFiles.delete", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}", "parameterOrder": [ "name" ], "httpMethod": "DELETE", "parameters": { "forceDelete": { "location": "query", "description": "Optional. If set to true, any errors generated by external vector database during the deletion will be ignored. The default value is false.", "type": "boolean" }, "name": { "required": true, "type": "string", "location": "path", "description": "Required. The name of the RagFile resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`", "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$" } } } }, "resources": { "ragMetadata": { "methods": { "create": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/ragMetadata", "httpMethod": "POST", "id": "aiplatform.projects.locations.ragCorpora.ragFiles.ragMetadata.create", "parameters": { "parent": { "location": "path", "description": "Required. The parent resource where this metadata will be created. Format: `projects/{project_number}/locations/{location_id}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$" }, "ragMetadataId": { "type": "string", "description": "Optional. The ID to use for the metadata, which will become the final component of the metadata's resource name if the user chooses to specify. Otherwise, metadata id will be generated by system. This value should be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.", "location": "query" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1RagMetadata" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "description": "Creates a RagMetadata.", "path": "v1beta1/{+parent}/ragMetadata", "response": { "$ref": "GoogleCloudAiplatformV1beta1RagMetadata" } }, "patch": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/ragMetadata/{ragMetadataId}", "request": { "$ref": "GoogleCloudAiplatformV1beta1RagMetadata" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1RagMetadata" }, "description": "Updates a RagMetadata.", "httpMethod": "PATCH", "id": "aiplatform.projects.locations.ragCorpora.ragFiles.ragMetadata.patch", "parameters": { "name": { "required": true, "description": "Identifier. Resource name of the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}`", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/ragMetadata/[^/]+$" } }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}" }, "batchDelete": { "request": { "$ref": "GoogleCloudAiplatformV1beta1BatchDeleteRagMetadataRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/ragMetadata:batchDelete", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$", "description": "Required. The resource name of the RagFile from which to delete the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`", "required": true, "location": "path" } }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Batch Deletes one or more RagMetadata.", "path": "v1beta1/{+parent}/ragMetadata:batchDelete", "id": "aiplatform.projects.locations.ragCorpora.ragFiles.ragMetadata.batchDelete" }, "list": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/ragMetadata", "httpMethod": "GET", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListRagMetadataResponse" }, "path": "v1beta1/{+parent}/ragMetadata", "id": "aiplatform.projects.locations.ragCorpora.ragFiles.ragMetadata.list", "parameters": { "pageSize": { "type": "integer", "description": "Optional. The standard list page size. The maximum value is 100. If not specified, a default value of 100 will be used.", "format": "int32", "location": "query" }, "pageToken": { "description": "Optional. The standard list page token. Typically obtained via ListRagMetadataResponse.next_page_token of the previous VertexRagDataService.ListRagMetadata call.", "type": "string", "location": "query" }, "parent": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$", "description": "Required. The resource name of the RagFile from which to list the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`", "required": true } }, "description": "Lists RagMetadata in a RagFile.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ] }, "delete": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/ragMetadata/{ragMetadataId}", "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "required": true, "description": "Required. The name of the RagMetadata resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}`", "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/ragMetadata/[^/]+$", "type": "string" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.ragCorpora.ragFiles.ragMetadata.delete", "parameterOrder": [ "name" ], "description": "Deletes a RagMetadata." }, "get": { "response": { "$ref": "GoogleCloudAiplatformV1beta1RagMetadata" }, "description": "Gets a RagMetadata.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/ragMetadata/{ragMetadataId}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.ragCorpora.ragFiles.ragMetadata.get", "httpMethod": "GET", "path": "v1beta1/{+name}", "parameters": { "name": { "description": "Required. The name of the RagMetadata resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}`", "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/ragMetadata/[^/]+$", "location": "path", "type": "string", "required": true } } }, "batchCreate": { "id": "aiplatform.projects.locations.ragCorpora.ragFiles.ragMetadata.batchCreate", "parameterOrder": [ "parent" ], "description": "Batch Create one or more RagMetadatas", "request": { "$ref": "GoogleCloudAiplatformV1beta1BatchCreateRagMetadataRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/ragMetadata:batchCreate", "parameters": { "parent": { "description": "Required. The parent resource where the RagMetadata will be created. Format: `projects/{project_number}/locations/{location_id}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$", "location": "path" } }, "httpMethod": "POST", "path": "v1beta1/{+parent}/ragMetadata:batchCreate" } } }, "operations": { "methods": { "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource.", "type": "string", "required": true } }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.delete", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "httpMethod": "DELETE", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", "parameterOrder": [ "name" ] }, "cancel": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation resource to be cancelled.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.cancel", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "path": "v1beta1/{+name}:cancel", "parameterOrder": [ "name" ] }, "wait": { "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation resource to wait on.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$" }, "timeout": { "type": "string", "location": "query", "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:wait", "httpMethod": "POST", "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.wait", "parameterOrder": [ "name" ] }, "list": { "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.list", "httpMethod": "GET", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$", "location": "path", "type": "string", "required": true, "description": "The name of the operation's parent resource." }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "pageSize": { "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" } }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1beta1/{+name}/operations" } } } } } } }, "pipelineJobs": { "resources": { "operations": { "methods": { "get": { "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}", "httpMethod": "GET", "id": "aiplatform.projects.locations.pipelineJobs.operations.get", "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$" } }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "cancel": { "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel", "path": "v1beta1/{+name}:cancel", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource to be cancelled." } }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "id": "aiplatform.projects.locations.pipelineJobs.operations.cancel" }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.pipelineJobs.operations.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be deleted.", "type": "string", "required": true } }, "parameterOrder": [ "name" ], "httpMethod": "DELETE", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}" }, "list": { "httpMethod": "GET", "parameters": { "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "pageSize": { "description": "The standard list page size.", "location": "query", "format": "int32", "type": "integer" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "name": { "location": "path", "type": "string", "description": "The name of the operation's parent resource.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$" } }, "path": "v1beta1/{+name}/operations", "id": "aiplatform.projects.locations.pipelineJobs.operations.list", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameterOrder": [ "name" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations" }, "wait": { "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait", "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to wait on.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$", "location": "path" }, "timeout": { "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration", "location": "query" } }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.pipelineJobs.operations.wait", "path": "v1beta1/{+name}:wait" } } } }, "methods": { "batchCancel": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1BatchCancelPipelineJobsRequest" }, "parameters": { "parent": { "required": true, "type": "string", "description": "Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "path": "v1beta1/{+parent}/pipelineJobs:batchCancel", "id": "aiplatform.projects.locations.pipelineJobs.batchCancel", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO.", "parameterOrder": [ "parent" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchCancel" }, "delete": { "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$", "required": true, "type": "string", "description": "Required. The name of the PipelineJob resource to be deleted. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`" } }, "httpMethod": "DELETE", "path": "v1beta1/{+name}", "description": "Deletes a PipelineJob.", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.pipelineJobs.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}" }, "batchDelete": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchDelete", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "path": "v1beta1/{+parent}/pipelineJobs:batchDelete", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "description": "Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}`", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.pipelineJobs.batchDelete", "description": "Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted.", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1BatchDeletePipelineJobsRequest" } }, "get": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}", "id": "aiplatform.projects.locations.pipelineJobs.get", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the PipelineJob resource. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`", "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$", "location": "path", "type": "string", "required": true } }, "description": "Gets a PipelineJob.", "response": { "$ref": "GoogleCloudAiplatformV1beta1PipelineJob" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "parameterOrder": [ "name" ] }, "list": { "parameterOrder": [ "parent" ], "id": "aiplatform.projects.locations.pipelineJobs.list", "description": "Lists PipelineJobs in a Location.", "path": "v1beta1/{+parent}/pipelineJobs", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListPipelineJobsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs", "parameters": { "parent": { "type": "string", "location": "path", "required": true, "description": "Required. The resource name of the Location to list the PipelineJobs from. Format: `projects/{project}/locations/{location}`", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageSize": { "type": "integer", "location": "query", "description": "The standard list page size.", "format": "int32" }, "orderBy": { "description": "A comma-separated list of fields to order by. The default sort order is in ascending order. Use \"desc\" after a field name for descending. You can have multiple order_by fields provided e.g. \"create_time desc, end_time\", \"end_time, start_time, update_time\" For example, using \"create_time desc, end_time\" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if order_by is not specified, it will order by default order is create time in descending order. Supported fields: * `create_time` * `update_time` * `end_time` * `start_time`", "location": "query", "type": "string" }, "filter": { "type": "string", "description": "Lists the PipelineJobs that match the filter expression. The following fields are supported: * `pipeline_name`: Supports `=` and `!=` comparisons. * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard. for example, can check if pipeline's display_name contains *step* by doing display_name:\\\"*step*\\\" * `state`: Supports `=` and `!=` comparisons. * `create_time`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, and `\u003e=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, and `\u003e=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, and `\u003e=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard. * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:` wildcard. Filter expressions can be combined together using logical operators (`AND` & `OR`). For example: `pipeline_name=\"test\" AND create_time\u003e\"2020-05-18T13:30:00Z\"`. The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `create_time\u003e\"2021-05-18T00:00:00Z\" OR update_time\u003e\"2020-05-18T00:00:00Z\"` PipelineJobs created or updated after 2020-05-18 00:00:00 UTC. * `labels.env = \"prod\"` PipelineJobs with label \"env\" set to \"prod\".", "location": "query" }, "readMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Mask specifying which fields to read." }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call." } } }, "cancel": { "description": "Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and PipelineJob.state is set to `CANCELLED`.", "request": { "$ref": "GoogleCloudAiplatformV1beta1CancelPipelineJobRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:cancel", "id": "aiplatform.projects.locations.pipelineJobs.cancel", "parameterOrder": [ "name" ], "httpMethod": "POST", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "location": "path", "type": "string", "required": true, "description": "Required. The name of the PipelineJob to cancel. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`", "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}:cancel" }, "create": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs", "path": "v1beta1/{+parent}/pipelineJobs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1PipelineJob" }, "id": "aiplatform.projects.locations.pipelineJobs.create", "description": "Creates a PipelineJob. A PipelineJob will run immediately when created.", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1PipelineJob" }, "parameters": { "parent": { "description": "Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "pipelineJobId": { "location": "query", "description": "The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`.", "type": "string" } }, "httpMethod": "POST" } } }, "schedules": { "methods": { "get": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", "required": true, "description": "Required. The name of the Schedule resource. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", "location": "path", "type": "string" } }, "httpMethod": "GET", "description": "Gets a Schedule.", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "response": { "$ref": "GoogleCloudAiplatformV1beta1Schedule" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", "id": "aiplatform.projects.locations.schedules.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "resume": { "description": "Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catch_up is set up true, all missed runs will be scheduled for backfill first.", "request": { "$ref": "GoogleCloudAiplatformV1beta1ResumeScheduleRequest" }, "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume", "parameters": { "name": { "type": "string", "location": "path", "description": "Required. The name of the Schedule resource to be resumed. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:resume", "id": "aiplatform.projects.locations.schedules.resume", "httpMethod": "POST" }, "list": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The resource name of the Location to list the Schedules from. Format: `projects/{project}/locations/{location}`", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "location": "query", "description": "The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call.", "type": "string" }, "pageSize": { "location": "query", "description": "The standard list page size. Default to 100 if not specified.", "type": "integer", "format": "int32" }, "orderBy": { "description": "A comma-separated list of fields to order by. The default sort order is in ascending order. Use \"desc\" after a field name for descending. You can have multiple order_by fields provided. For example, using \"create_time desc, end_time\" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time`", "location": "query", "type": "string" }, "filter": { "type": "string", "location": "query", "description": "Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --\u003e Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, and `\u003e=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, and `\u003e=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, `\u003e=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, and `\u003e=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state=\"ACTIVE\" AND display_name:\"my_schedule_*\"` * `NOT display_name=\"my_schedule\"` * `create_time\u003e\"2021-05-18T00:00:00Z\"` * `end_time\u003e\"2021-05-18T00:00:00Z\" OR NOT end_time:*` * `create_pipeline_job_request:*`" } }, "path": "v1beta1/{+parent}/schedules", "description": "Lists Schedules in a Location.", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListSchedulesResponse" }, "id": "aiplatform.projects.locations.schedules.list", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules" }, "create": { "parameters": { "parent": { "description": "Required. The resource name of the Location to create the Schedule in. Format: `projects/{project}/locations/{location}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "location": "path" } }, "httpMethod": "POST", "response": { "$ref": "GoogleCloudAiplatformV1beta1Schedule" }, "description": "Creates a Schedule.", "request": { "$ref": "GoogleCloudAiplatformV1beta1Schedule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules", "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/schedules", "id": "aiplatform.projects.locations.schedules.create" }, "pause": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", "description": "Required. The name of the Schedule resource to be paused. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", "location": "path" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1PauseScheduleRequest" }, "path": "v1beta1/{+name}:pause", "httpMethod": "POST", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause", "id": "aiplatform.projects.locations.schedules.pause" }, "delete": { "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.schedules.delete", "path": "v1beta1/{+name}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a Schedule.", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "description": "Required. The name of the Schedule resource to be deleted. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", "location": "path", "type": "string", "required": true } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}" }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1Schedule" }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1Schedule" }, "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", "id": "aiplatform.projects.locations.schedules.patch", "parameters": { "updateMask": { "location": "query", "format": "google-fieldmask", "type": "string", "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask." }, "name": { "type": "string", "description": "Immutable. The resource name of the Schedule.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", "required": true } }, "description": "Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.", "httpMethod": "PATCH" } }, "resources": { "operations": { "methods": { "get": { "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "id": "aiplatform.projects.locations.schedules.operations.get", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "type": "string", "required": true, "location": "path", "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$" } } }, "wait": { "id": "aiplatform.projects.locations.schedules.operations.wait", "path": "v1beta1/{+name}:wait", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to wait on.", "type": "string", "location": "path" }, "timeout": { "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration", "location": "query" } }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "cancel": { "path": "v1beta1/{+name}:cancel", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.schedules.operations.cancel", "response": { "$ref": "GoogleProtobufEmpty" } }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameters": { "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "name": { "required": true, "type": "string", "description": "The name of the operation's parent resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$" }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "pageSize": { "format": "int32", "description": "The standard list page size.", "type": "integer", "location": "query" } }, "path": "v1beta1/{+name}/operations", "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.schedules.operations.list", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations" }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path", "description": "The name of the operation resource to be deleted." } }, "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.schedules.operations.delete" } } } } }, "extensionControllers": { "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "required": true, "type": "string", "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$" } }, "id": "aiplatform.projects.locations.extensionControllers.operations.cancel", "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}:cancel", "path": "v1beta1/{+name}:cancel", "response": { "$ref": "GoogleProtobufEmpty" } }, "get": { "parameters": { "name": { "required": true, "type": "string", "location": "path", "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$" } }, "httpMethod": "GET", "path": "v1beta1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.extensionControllers.operations.get" }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.extensionControllers.operations.list", "parameterOrder": [ "name" ], "parameters": { "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "pageSize": { "location": "query", "description": "The standard list page size.", "format": "int32", "type": "integer" }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "name": { "required": true, "type": "string", "description": "The name of the operation's parent resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+$" } }, "httpMethod": "GET", "path": "v1beta1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.extensionControllers.operations.delete", "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation resource to be deleted.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$" } } }, "wait": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.extensionControllers.operations.wait", "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "path": "v1beta1/{+name}:wait", "parameters": { "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "format": "google-duration", "location": "query" }, "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to wait on." } }, "response": { "$ref": "GoogleLongrunningOperation" } } } } } }, "monitoredAgents": { "methods": { "disable": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1DisableMonitoredAgentRequest" }, "description": "Disables a specific MonitoredAgent.", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}:disable", "id": "aiplatform.projects.locations.monitoredAgents.disable", "path": "v1beta1/{+name}:disable", "parameters": { "name": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+$", "description": "Required. The name of the MonitoredAgent resource to be disabled. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}`" } } }, "enable": { "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "parameters": { "name": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+$", "description": "Required. The name of the MonitoredAgent resource to be enabled. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}`" } }, "description": "Enables a specific MonitoredAgent.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}:enable", "path": "v1beta1/{+name}:enable", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.monitoredAgents.enable", "request": { "$ref": "GoogleCloudAiplatformV1beta1EnableMonitoredAgentRequest" } }, "list": { "description": "Lists MonitoredAgents in a specific Location.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1ListMonitoredAgentsResponse" }, "id": "aiplatform.projects.locations.monitoredAgents.list", "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "pageToken": { "type": "string", "location": "query", "description": "Optional. The standard list page token." }, "parent": { "required": true, "type": "string", "location": "path", "description": "Required. The resource name of the Location to list the MonitoredAgents from. Format: `projects/{project}/locations/{location}`", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "filter": { "description": "Optional. An AIP-160 filter, currently restricted to a single equality predicate on `state`. The value must be the exact, case-sensitive name of a `MonitoredAgent.EnablementState` value: `ACTIVE`, `DISABLED`, `ENABLING`, or `ENABLEMENT_STATE_UNSPECIFIED`. A blank or absent filter returns every MonitoredAgent in the parent regardless of state; any other value returns `INVALID_ARGUMENT`. Example: ``` state = ACTIVE ```", "type": "string", "location": "query" }, "pageSize": { "type": "integer", "description": "Optional. The standard list page size. The maximum value is 100; values above 100 will be coerced to 100. If unspecified, at most 10 MonitoredAgents will be returned.", "location": "query", "format": "int32" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents", "path": "v1beta1/{+parent}/monitoredAgents" }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudAiplatformV1beta1MonitoredAgent" }, "description": "Gets the details of a specific MonitoredAgent.", "parameters": { "name": { "description": "Required. The name of the MonitoredAgent resource. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}`", "pattern": "^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+$", "type": "string", "required": true, "location": "path" } }, "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.monitoredAgents.get", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}" } }, "resources": { "analyzedSessions": { "methods": { "aggregate": { "response": { "$ref": "GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Aggregates AnalyzedSessions across MonitoredAgents. To aggregate across all MonitoredAgents in a location, use the following format for the parent field: `projects/{project}/locations/{location}/monitoredAgents/-`", "parameterOrder": [ "parent" ], "parameters": { "pageToken": { "location": "query", "description": "Optional. The standard list page token.", "type": "string" }, "parent": { "description": "Required. The parent MonitoredAgent resource. Use the `-` wildcard for the monitored_agent segment to aggregate across multiple agents in the location. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+$", "type": "string", "location": "path" }, "filter": { "location": "query", "description": "Optional. Filter expression restricting which AnalyzedSessions are included in the aggregation. Supports a subset of the `ListAnalyzedSessionsRequest.filter` grammar: a closed `detection_time` window with both bounds required. The `severity` clause is not supported here. If empty, the aggregation covers the last 3 days. Example: ``` detection_time \u003e= \"2024-01-01T00:00:00Z\" AND detection_time \u003c= \"2024-01-08T00:00:00Z\" ```", "type": "string" }, "pageSize": { "type": "integer", "location": "query", "description": "Optional. The standard list page size. The maximum value is 100; values above 100 will be coerced to 100. If unspecified, at most 10 MonitoredAgents will be returned.", "format": "int32" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}/analyzedSessions:aggregate", "httpMethod": "GET", "id": "aiplatform.projects.locations.monitoredAgents.analyzedSessions.aggregate", "path": "v1beta1/{+parent}/analyzedSessions:aggregate" }, "list": { "response": { "$ref": "GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponse" }, "parameters": { "filter": { "type": "string", "location": "query", "description": "Optional. Filter expression restricting which AnalyzedSessions are returned. Supports a subset of AIP-160: a closed `detection_time` window (both bounds required), an equality on `severity`, and an equality on `agent_type`, joined by `AND`. Each clause is optional, may appear at most once, and may appear in any order. The `severity` value is the **canonical** `Severity` enum name -- `SEVERITY_CRITICAL`, `SEVERITY_HIGH`, `SEVERITY_MEDIUM` or `SEVERITY_LOW`. Short forms such as `\"CRITICAL\"` are rejected, as is `SEVERITY_UNSPECIFIED`. It matches sessions whose *maximum* severity equals that bucket: a session that fires at both LOW and CRITICAL matches `severity = \"SEVERITY_CRITICAL\"`, not `severity = \"SEVERITY_LOW\"`. The `agent_type` value is the canonical `AgentResource.AgentType` enum name -- `REASONING_ENGINE`, `CLOUD_RUN_SERVICE`, `GKE_WORKLOAD`, `GCE_INSTANCE`, `AGENT_TYPE_OTHER` or `AGENT_TYPE_UNSPECIFIED` -- and matches sessions run by an agent on that runtime. Unlike `severity`, `agent_type` accepts its `UNSPECIFIED` value. The two are not analogous: a session always has a computed severity bucket, so `SEVERITY_UNSPECIFIED` is never returned and filtering on it could only match nothing. `AGENT_TYPE_UNSPECIFIED` *is* returned -- it is what `AnalyzedSession.agent_type` reports for an agent whose runtime was never recorded -- so it must remain filterable. Example (time window, severity and runtime): ``` detection_time \u003e= \"2024-01-01T00:00:00Z\" AND detection_time \u003c= \"2024-01-08T00:00:00Z\" AND severity = \"SEVERITY_CRITICAL\" AND agent_type = \"CLOUD_RUN_SERVICE\" ``` If empty, results are restricted to the last 7 days with no severity or runtime restriction. Other fields, additional operators, set membership (`IN`), and boolean combinations (`OR`, `NOT`, parentheses) are not yet supported." }, "view": { "enumDescriptions": [ "The default view: BASIC.", "Basic view includes only the fields needed for the list table (name, session_id, created_time, severity counts).", "Full view includes all fields, including the detailed assessment." ], "enum": [ "ANALYZED_SESSION_VIEW_UNSPECIFIED", "ANALYZED_SESSION_VIEW_BASIC", "ANALYZED_SESSION_VIEW_FULL" ], "description": "Optional. Resource view to control which fields are returned.", "type": "string", "location": "query" }, "pageToken": { "type": "string", "description": "Optional. A page token, received from a previous `ListAnalyzedSessions` call.", "location": "query" }, "orderBy": { "description": "Optional. Comma-separated list of fields to sort by, following AIP-132 syntax. The default sort direction is ascending; append \" desc\" to a field to sort descending. Supported fields (any other field yields INVALID_ARGUMENT): * `latest_detection_time` - the session's most-recent flagged detection time. `latest_detection_time desc` puts the newest sessions first. * `max_severity_rank` - the session's bucketed maximum severity, ranked LOW=1 \u003c MEDIUM=2 \u003c HIGH=3 \u003c CRITICAL=4. `max_severity_rank desc` puts the most-severe sessions first. * `agent_display_name` - the MonitoredAgent's display name. Sorted as a STRING (case-sensitive, code-point order). If empty, defaults to `latest_detection_time desc`. Multi-field sort (for example, `max_severity_rank desc, latest_detection_time desc`) is supported. The `order_by` value MUST match the value used on the call that minted any supplied `page_token` (AIP-158). Mismatches yield INVALID_ARGUMENT.", "type": "string", "location": "query" }, "parent": { "description": "Required. The parent MonitoredAgent resource. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}`", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+$" }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "Optional. The maximum number of analyzed sessions to return." } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}/analyzedSessions", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.monitoredAgents.analyzedSessions.list", "path": "v1beta1/{+parent}/analyzedSessions", "description": "Lists AnalyzedSessions in a MonitoredAgent.", "parameterOrder": [ "parent" ] }, "get": { "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.monitoredAgents.analyzedSessions.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+/analyzedSessions/[^/]+$", "location": "path", "description": "Required. The name of the AnalyzedSession resource. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}/analyzedSessions/{analyzed_session}`", "type": "string", "required": true }, "view": { "enum": [ "ANALYZED_SESSION_VIEW_UNSPECIFIED", "ANALYZED_SESSION_VIEW_BASIC", "ANALYZED_SESSION_VIEW_FULL" ], "enumDescriptions": [ "The default view: BASIC.", "Basic view includes only the fields needed for the list table (name, session_id, created_time, severity counts).", "Full view includes all fields, including the detailed assessment." ], "description": "Optional. Resource view to control which fields are returned.", "type": "string", "location": "query" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1AnalyzedSession" }, "description": "Gets the details of a specific AnalyzedSession.", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}/analyzedSessions/{analyzedSessionsId}" } }, "resources": { "analyzedInvocations": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+parent}/analyzedInvocations", "parameterOrder": [ "parent" ], "description": "Lists AnalyzedInvocations in a MonitoredAgent's AnalyzedSession.", "id": "aiplatform.projects.locations.monitoredAgents.analyzedSessions.analyzedInvocations.list", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListAnalyzedInvocationsResponse" }, "httpMethod": "GET", "parameters": { "pageToken": { "description": "Optional. A page token, received from a previous `ListAnalyzedInvocations` call.", "location": "query", "type": "string" }, "parent": { "location": "path", "description": "Required. The parent AnalyzedSession resource. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}/analyzedSessions/{analyzed_session}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+/analyzedSessions/[^/]+$", "type": "string" }, "pageSize": { "description": "Optional. The maximum number of analyzed invocations to return.", "location": "query", "type": "integer", "format": "int32" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}/analyzedSessions/{analyzedSessionsId}/analyzedInvocations" }, "get": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}/analyzedSessions/{analyzedSessionsId}/analyzedInvocations/{analyzedInvocationsId}", "response": { "$ref": "GoogleCloudAiplatformV1beta1AnalyzedInvocation" }, "description": "Gets the details of a specific AnalyzedInvocation.", "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.monitoredAgents.analyzedSessions.analyzedInvocations.get", "parameters": { "name": { "location": "path", "description": "Required. The name of the AnalyzedInvocation resource. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}/analyzedSessions/{analyzed_session}/analyzedInvocations/{analyzed_invocation}`", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+/analyzedSessions/[^/]+/analyzedInvocations/[^/]+$" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET" } } } } } } }, "evaluationTasks": { "resources": { "operations": { "methods": { "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/evaluationTasks/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation resource to be deleted.", "required": true } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations/{operationsId}", "httpMethod": "DELETE", "id": "aiplatform.projects.locations.evaluationTasks.operations.delete", "path": "v1beta1/{+name}" }, "wait": { "httpMethod": "POST", "id": "aiplatform.projects.locations.evaluationTasks.operations.wait", "parameterOrder": [ "name" ], "parameters": { "timeout": { "location": "query", "format": "google-duration", "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." }, "name": { "description": "The name of the operation resource to wait on.", "pattern": "^projects/[^/]+/locations/[^/]+/evaluationTasks/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "required": true } }, "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations/{operationsId}:wait" }, "get": { "id": "aiplatform.projects.locations.evaluationTasks.operations.get", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations/{operationsId}", "httpMethod": "GET", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "path": "v1beta1/{+name}", "parameters": { "name": { "required": true, "location": "path", "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/evaluationTasks/[^/]+/operations/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" } }, "list": { "httpMethod": "GET", "parameters": { "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/evaluationTasks/[^/]+$", "description": "The name of the operation's parent resource.", "type": "string", "location": "path" }, "pageSize": { "description": "The standard list page size.", "type": "integer", "location": "query", "format": "int32" }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1beta1/{+name}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.evaluationTasks.operations.list" } } } } }, "datasets": { "methods": { "getIamPolicy": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "options.requestedPolicyVersion": { "type": "integer", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query" }, "resource": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "required": true } }, "parameterOrder": [ "resource" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:getIamPolicy", "path": "v1beta1/{+resource}:getIamPolicy", "response": { "$ref": "GoogleIamV1Policy" }, "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "id": "aiplatform.projects.locations.datasets.getIamPolicy" }, "get": { "response": { "$ref": "GoogleCloudAiplatformV1beta1Dataset" }, "id": "aiplatform.projects.locations.datasets.get", "description": "Gets a Dataset.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, "description": "Required. The name of the Dataset resource." }, "readMask": { "location": "query", "description": "Mask specifying which fields to read.", "type": "string", "format": "google-fieldmask" } } }, "create": { "request": { "$ref": "GoogleCloudAiplatformV1beta1Dataset" }, "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.datasets.create", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets", "path": "v1beta1/{+parent}/datasets", "parameters": { "parent": { "required": true, "description": "Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "parameterOrder": [ "parent" ], "description": "Creates a Dataset." }, "patch": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "location": "path", "required": true, "description": "Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", "type": "string" }, "updateMask": { "type": "string", "format": "google-fieldmask", "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels`", "location": "query" } }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "response": { "$ref": "GoogleCloudAiplatformV1beta1Dataset" }, "httpMethod": "PATCH", "description": "Updates a Dataset.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1Dataset" }, "id": "aiplatform.projects.locations.datasets.patch" }, "list": { "path": "v1beta1/{+parent}/datasets", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListDatasetsResponse" }, "description": "Lists Datasets in a Location.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.datasets.list", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets", "parameters": { "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "parent": { "description": "Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageSize": { "description": "The standard list page size.", "location": "query", "format": "int32", "type": "integer" }, "orderBy": { "type": "string", "location": "query", "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time`" }, "filter": { "description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"`", "location": "query", "type": "string" }, "readMask": { "location": "query", "type": "string", "format": "google-fieldmask", "description": "Mask specifying which fields to read." } }, "httpMethod": "GET", "parameterOrder": [ "parent" ] }, "export": { "path": "v1beta1/{+name}:export", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:export", "id": "aiplatform.projects.locations.datasets.export", "description": "Exports data from a Dataset.", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1ExportDataRequest" }, "httpMethod": "POST" }, "assemble": { "parameters": { "name": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, "description": "Required. The name of the Dataset resource (used only for MULTIMODAL datasets). Format: `projects/{project}/locations/{location}/datasets/{dataset}`" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1AssembleDataRequest" }, "httpMethod": "POST", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Assembles each row of a multimodal dataset and writes the result into a BigQuery table.", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:assemble", "path": "v1beta1/{+name}:assemble", "id": "aiplatform.projects.locations.datasets.assemble" }, "import": { "parameters": { "name": { "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, "type": "string", "location": "path" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:import", "id": "aiplatform.projects.locations.datasets.import", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1ImportDataRequest" }, "path": "v1beta1/{+name}:import", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Imports data into a Dataset." }, "assess": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:assess", "path": "v1beta1/{+name}:assess", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.datasets.assess", "httpMethod": "POST", "description": "Assesses the state or validity of the dataset with respect to a given use case.", "request": { "$ref": "GoogleCloudAiplatformV1beta1AssessDataRequest" }, "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "description": "Required. The name of the Dataset resource. Used only for MULTIMODAL datasets. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", "type": "string", "location": "path" } } }, "setIamPolicy": { "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string", "required": true, "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path" } }, "id": "aiplatform.projects.locations.datasets.setIamPolicy", "httpMethod": "POST", "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:setIamPolicy", "response": { "$ref": "GoogleIamV1Policy" }, "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "path": "v1beta1/{+resource}:setIamPolicy", "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors." }, "testIamPermissions": { "id": "aiplatform.projects.locations.datasets.testIamPermissions", "path": "v1beta1/{+resource}:testIamPermissions", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:testIamPermissions", "parameterOrder": [ "resource" ], "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "parameters": { "permissions": { "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", "type": "string", "location": "query", "repeated": true }, "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "location": "path", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "required": true, "type": "string" } }, "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST" }, "delete": { "description": "Deletes a Dataset.", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.datasets.delete", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "location": "path", "description": "Required. The resource name of the Dataset to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", "required": true } } }, "searchDataItems": { "parameterOrder": [ "dataset" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1SearchDataItemsResponse" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Searches DataItems in a Dataset.", "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:searchDataItems", "parameters": { "pageSize": { "type": "integer", "description": "Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.", "location": "query", "format": "int32" }, "dataLabelingJob": { "description": "The resource name of a DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` If this field is set, all of the search will be done in the context of this DataLabelingJob.", "type": "string", "location": "query" }, "orderByAnnotation.orderBy": { "description": "A comma-separated list of annotation fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Must also specify saved_query.", "location": "query", "type": "string" }, "pageToken": { "type": "string", "location": "query", "description": "A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call." }, "savedQuery": { "deprecated": true, "location": "query", "type": "string", "description": "The resource name of a SavedQuery(annotation set in UI). Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}` All of the search will be done in the context of this SavedQuery." }, "annotationsLimit": { "type": "integer", "location": "query", "format": "int32", "description": "If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used." }, "dataItemFilter": { "type": "string", "description": "An expression for filtering the DataItem that will be returned. * `data_item_id` - for = or !=. * `labeled` - for = or !=. * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that have at least one annotation with annotation_spec_id = `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. For example: * `data_item=1` * `has_annotation(5)`", "location": "query" }, "annotationsFilter": { "description": "An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=.", "location": "query", "type": "string", "deprecated": true }, "orderByDataItem": { "description": "A comma-separated list of data item fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", "location": "query", "type": "string" }, "dataset": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", "required": true }, "annotationFilters": { "type": "string", "repeated": true, "description": "An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * `annotation_spec_id` - for = or !=. Must specify `saved_query_id=` - saved query id that annotations should belong to.", "location": "query" }, "fieldMask": { "description": "Mask specifying which fields of DataItemView to read.", "location": "query", "format": "google-fieldmask", "type": "string" }, "orderByAnnotation.savedQuery": { "description": "Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.", "location": "query", "type": "string" }, "orderBy": { "deprecated": true, "location": "query", "type": "string", "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending." } }, "path": "v1beta1/{+dataset}:searchDataItems", "id": "aiplatform.projects.locations.datasets.searchDataItems" } }, "resources": { "operations": { "methods": { "wait": { "parameters": { "name": { "location": "path", "type": "string", "required": true, "description": "The name of the operation resource to wait on.", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$" }, "timeout": { "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "type": "string" } }, "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.datasets.operations.wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "path": "v1beta1/{+name}:wait", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:wait" }, "get": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.datasets.operations.get", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}" }, "list": { "parameterOrder": [ "name" ], "path": "v1beta1/{+name}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations", "parameters": { "pageSize": { "type": "integer", "description": "The standard list page size.", "format": "int32", "location": "query" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "location": "path", "required": true, "description": "The name of the operation's parent resource.", "type": "string" } }, "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "id": "aiplatform.projects.locations.datasets.operations.list", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "cancel": { "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:cancel", "id": "aiplatform.projects.locations.datasets.operations.cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "path": "v1beta1/{+name}:cancel", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation resource to be cancelled.", "required": true } }, "httpMethod": "POST" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.projects.locations.datasets.operations.delete", "httpMethod": "DELETE", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", "location": "path", "required": true } } } } }, "datasetVersions": { "methods": { "get": { "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", "response": { "$ref": "GoogleCloudAiplatformV1beta1DatasetVersion" }, "id": "aiplatform.projects.locations.datasets.datasetVersions.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`" }, "readMask": { "format": "google-fieldmask", "location": "query", "type": "string", "description": "Mask specifying which fields to read." } }, "parameterOrder": [ "name" ], "httpMethod": "GET", "description": "Gets a Dataset version." }, "create": { "path": "v1beta1/{+parent}/datasetVersions", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions", "parameters": { "parent": { "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "type": "string" } }, "id": "aiplatform.projects.locations.datasets.datasetVersions.create", "request": { "$ref": "GoogleCloudAiplatformV1beta1DatasetVersion" }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Create a version from a Dataset." }, "delete": { "description": "Deletes a Dataset version.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", "required": true, "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", "id": "aiplatform.projects.locations.datasets.datasetVersions.delete", "path": "v1beta1/{+name}" }, "restore": { "parameters": { "name": { "description": "Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$" } }, "httpMethod": "GET", "id": "aiplatform.projects.locations.datasets.datasetVersions.restore", "path": "v1beta1/{+name}:restore", "parameterOrder": [ "name" ], "description": "Restores a dataset version.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore" }, "patch": { "description": "Updates a DatasetVersion.", "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.datasets.datasetVersions.patch", "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudAiplatformV1beta1DatasetVersion" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1DatasetVersion" }, "parameters": { "name": { "required": true, "location": "path", "description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", "type": "string" }, "updateMask": { "type": "string", "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name`", "format": "google-fieldmask", "location": "query" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}" }, "list": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions", "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/datasetVersions", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListDatasetVersionsResponse" }, "description": "Lists DatasetVersions in a Dataset.", "id": "aiplatform.projects.locations.datasets.datasetVersions.list", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "location": "path", "description": "Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", "type": "string", "required": true }, "orderBy": { "type": "string", "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", "location": "query" }, "readMask": { "location": "query", "format": "google-fieldmask", "description": "Optional. Mask specifying which fields to read.", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The standard list page size.", "location": "query" }, "filter": { "description": "Optional. The standard list filter.", "type": "string", "location": "query" }, "pageToken": { "type": "string", "location": "query", "description": "Optional. The standard list page token." } } } } }, "savedQueries": { "methods": { "delete": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$", "required": true, "type": "string", "description": "Required. The resource name of the SavedQuery to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`" } }, "httpMethod": "DELETE", "description": "Deletes a SavedQuery.", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}", "id": "aiplatform.projects.locations.datasets.savedQueries.delete" }, "list": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1ListSavedQueriesResponse" }, "description": "Lists SavedQueries in a Dataset.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.datasets.savedQueries.list", "httpMethod": "GET", "path": "v1beta1/{+parent}/savedQueries", "parameters": { "readMask": { "location": "query", "description": "Mask specifying which fields to read.", "type": "string", "format": "google-fieldmask" }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "pageSize": { "format": "int32", "location": "query", "description": "The standard list page size.", "type": "integer" }, "orderBy": { "type": "string", "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", "location": "query" }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "parent": { "type": "string", "required": true, "description": "Required. The resource name of the Dataset to list SavedQueries from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$" } } } }, "resources": { "operations": { "methods": { "cancel": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be cancelled.", "type": "string", "required": true } }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "path": "v1beta1/{+name}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "id": "aiplatform.projects.locations.datasets.savedQueries.operations.cancel", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" } }, "wait": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameters": { "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration", "location": "query", "type": "string" }, "name": { "description": "The name of the operation resource to wait on.", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.datasets.savedQueries.operations.wait", "httpMethod": "POST", "path": "v1beta1/{+name}:wait" }, "get": { "httpMethod": "GET", "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", "description": "The name of the operation resource." } }, "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.datasets.savedQueries.operations.get", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" } }, "list": { "path": "v1beta1/{+name}/operations", "parameters": { "pageSize": { "format": "int32", "description": "The standard list page size.", "type": "integer", "location": "query" }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "returnPartialSuccess": { "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query" }, "name": { "required": true, "type": "string", "description": "The name of the operation's parent resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$" } }, "id": "aiplatform.projects.locations.datasets.savedQueries.operations.list", "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "delete": { "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.datasets.savedQueries.operations.delete", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to be deleted.", "location": "path", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." } } } } }, "dataItems": { "resources": { "annotations": { "methods": { "list": { "path": "v1beta1/{+parent}/annotations", "id": "aiplatform.projects.locations.datasets.dataItems.annotations.list", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations", "description": "Lists Annotations belongs to a dataitem.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "orderBy": { "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", "location": "query", "type": "string" }, "readMask": { "location": "query", "type": "string", "description": "Mask specifying which fields to read.", "format": "google-fieldmask" }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "The standard list page size." }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "parent": { "location": "path", "type": "string", "description": "Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$" } }, "parameterOrder": [ "parent" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListAnnotationsResponse" } } }, "resources": { "operations": { "methods": { "list": { "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.list", "path": "v1beta1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" }, "name": { "required": true, "description": "The name of the operation's parent resource.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+$" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "pageSize": { "format": "int32", "location": "query", "description": "The standard list page size.", "type": "integer" } }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "httpMethod": "GET", "parameterOrder": [ "name" ] }, "wait": { "path": "v1beta1/{+name}:wait", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.wait", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "timeout": { "format": "google-duration", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string" }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to wait on.", "type": "string" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done." }, "delete": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.delete", "httpMethod": "DELETE", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be deleted.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1beta1/{+name}" }, "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "httpMethod": "POST", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to be cancelled.", "location": "path", "type": "string" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.cancel", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel", "path": "v1beta1/{+name}:cancel" }, "get": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.get", "path": "v1beta1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", "description": "The name of the operation resource.", "required": true } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}", "httpMethod": "GET", "parameterOrder": [ "name" ] } } } } }, "operations": { "methods": { "wait": { "parameters": { "timeout": { "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "format": "google-duration" }, "name": { "description": "The name of the operation resource to wait on.", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait", "path": "v1beta1/{+name}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "id": "aiplatform.projects.locations.datasets.dataItems.operations.wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "parameterOrder": [ "name" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.datasets.dataItems.operations.delete", "path": "v1beta1/{+name}", "httpMethod": "DELETE", "parameters": { "name": { "required": true, "description": "The name of the operation resource to be deleted.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}", "response": { "$ref": "GoogleProtobufEmpty" } }, "list": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "path": "v1beta1/{+name}/operations", "parameters": { "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "The standard list page size." }, "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation's parent resource." } }, "id": "aiplatform.projects.locations.datasets.dataItems.operations.list", "parameterOrder": [ "name" ] }, "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "path": "v1beta1/{+name}:cancel", "parameters": { "name": { "location": "path", "description": "The name of the operation resource to be cancelled.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$" } }, "id": "aiplatform.projects.locations.datasets.dataItems.operations.cancel", "httpMethod": "POST", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "parameters": { "name": { "description": "The name of the operation resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", "type": "string", "required": true } }, "parameterOrder": [ "name" ], "httpMethod": "GET", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}", "id": "aiplatform.projects.locations.datasets.dataItems.operations.get", "response": { "$ref": "GoogleLongrunningOperation" } } } } }, "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.datasets.dataItems.list", "path": "v1beta1/{+parent}/dataItems", "description": "Lists DataItems in a Dataset.", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListDataItemsResponse" }, "parameters": { "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "orderBy": { "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", "location": "query", "type": "string" }, "parent": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, "description": "Required. The resource name of the Dataset to list DataItems from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`" }, "readMask": { "location": "query", "type": "string", "description": "Mask specifying which fields to read.", "format": "google-fieldmask" }, "pageSize": { "description": "The standard list page size.", "type": "integer", "location": "query", "format": "int32" } }, "parameterOrder": [ "parent" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems", "httpMethod": "GET" } } }, "annotationSpecs": { "methods": { "get": { "path": "v1beta1/{+name}", "httpMethod": "GET", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$", "location": "path", "description": "Required. The name of the AnnotationSpec resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}`", "required": true }, "readMask": { "description": "Mask specifying which fields to read.", "type": "string", "format": "google-fieldmask", "location": "query" } }, "id": "aiplatform.projects.locations.datasets.annotationSpecs.get", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1AnnotationSpec" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}", "description": "Gets an AnnotationSpec.", "parameterOrder": [ "name" ] } }, "resources": { "operations": { "methods": { "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$" } }, "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.delete", "path": "v1beta1/{+name}" }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "path": "v1beta1/{+name}:wait", "parameterOrder": [ "name" ], "parameters": { "timeout": { "format": "google-duration", "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query" }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource to wait on.", "required": true } }, "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.wait" }, "get": { "parameters": { "name": { "location": "path", "type": "string", "required": true, "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$" } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.get", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" } }, "cancel": { "path": "v1beta1/{+name}:cancel", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be cancelled.", "type": "string", "required": true } }, "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "httpMethod": "POST", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.cancel" }, "list": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1beta1/{+name}/operations", "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameters": { "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "The standard list page size." }, "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$", "required": true, "type": "string", "location": "path" } }, "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.list" } } } } } } }, "tuningJobs": { "methods": { "rebaseTunedModel": { "parameters": { "parent": { "required": true, "description": "Required. The resource name of the location in which to rebase the Model. Format: `projects/{project}/locations/{location}`", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "description": "Rebase a tuned model. A rebase operation takes a model that was previously tuned on a base model version, and retunes it on a new base model version. The rebase operation creates a new tuning job and a new tuned model.", "httpMethod": "POST", "path": "v1beta1/{+parent}/tuningJobs:rebaseTunedModel", "request": { "$ref": "GoogleCloudAiplatformV1beta1RebaseTunedModelRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.tuningJobs.rebaseTunedModel", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs:rebaseTunedModel" }, "processData": { "id": "aiplatform.projects.locations.tuningJobs.processData", "request": { "$ref": "GoogleCloudAiplatformV1beta1ProcessDataRequest" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Processes data from a user's Cloud Storage bucket and saves the result to a destination Cloud Storage bucket. This method returns a long-running operation, and the `ProcessDataResponse` will be returned upon completion.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs:processData", "parameters": { "parent": { "required": true, "type": "string", "description": "Required. The resource name of the Location to process the data in. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "path": "v1beta1/{+parent}/tuningJobs:processData", "httpMethod": "POST", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleLongrunningOperation" } }, "get": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.tuningJobs.get", "httpMethod": "GET", "path": "v1beta1/{+name}", "parameters": { "name": { "description": "Required. The name of the tuning job to retrieve. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", "type": "string", "required": true } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1TuningJob" }, "description": "Gets a tuning job.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}", "parameterOrder": [ "name" ] }, "optimizePrompt": { "parameterOrder": [ "parent" ], "id": "aiplatform.projects.locations.tuningJobs.optimizePrompt", "path": "v1beta1/{+parent}/tuningJobs:optimizePrompt", "description": "Optimizes a prompt. Given a prompt, this method returns a stream of optimized prompts expanded from the original prompt.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs:optimizePrompt", "response": { "$ref": "GoogleCloudAiplatformV1beta1OptimizePromptResponse" }, "parameters": { "parent": { "description": "Required. The resource name of the location to optimize the prompt in. Format: `projects/{project}/locations/{location}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "type": "string" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1OptimizePromptRequest" }, "httpMethod": "POST" }, "create": { "description": "Creates a tuning job. A created tuning job will be subsequently executed to start the model tuning process.", "id": "aiplatform.projects.locations.tuningJobs.create", "parameterOrder": [ "parent" ], "httpMethod": "POST", "parameters": { "parent": { "type": "string", "required": true, "description": "Required. The resource name of the location to create the tuning job in. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+parent}/tuningJobs", "response": { "$ref": "GoogleCloudAiplatformV1beta1TuningJob" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1TuningJob" } }, "list": { "response": { "$ref": "GoogleCloudAiplatformV1beta1ListTuningJobsResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.tuningJobs.list", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The resource name of the location to list the tuning jobs from. Format: `projects/{project}/locations/{location}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "location": "path" }, "filter": { "location": "query", "description": "Optional. The standard list filter.", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The standard list page size.", "location": "query" }, "pageToken": { "location": "query", "description": "Optional. The standard list page token. Typically obtained from ListTuningJobsResponse.next_page_token of the previous GenAiTuningService.ListTuningJobs call.", "type": "string" } }, "description": "Lists tuning jobs in a location.", "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/tuningJobs" }, "validateReinforcementTuningReward": { "id": "aiplatform.projects.locations.tuningJobs.validateReinforcementTuningReward", "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The resource name of the Location to validate the reward in Format: `projects/{project}/locations/{location}`" } }, "httpMethod": "POST", "response": { "$ref": "GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs:validateReinforcementTuningReward", "request": { "$ref": "GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardRequest" }, "description": "Validates a reward on a given example.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+parent}/tuningJobs:validateReinforcementTuningReward" }, "cancel": { "parameters": { "name": { "type": "string", "location": "path", "description": "Required. The name of the tuning job to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$" } }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1CancelTuningJobRequest" }, "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.tuningJobs.cancel", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel", "path": "v1beta1/{+name}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Cancels a tuning job. Starts an asynchronous cancellation request. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the tuning job is not deleted. Instead, its state is set to `CANCELLED`, and `error` is set to a status with a `google.rpc.Status.code` of 1, corresponding to `Code.CANCELLED`." } }, "resources": { "operations": { "methods": { "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}", "httpMethod": "DELETE", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", "required": true } }, "id": "aiplatform.projects.locations.tuningJobs.operations.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameterOrder": [ "name" ] }, "wait": { "httpMethod": "POST", "parameters": { "timeout": { "format": "google-duration", "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query" }, "name": { "type": "string", "description": "The name of the operation resource to wait on.", "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", "required": true, "location": "path" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:wait", "path": "v1beta1/{+name}:wait", "id": "aiplatform.projects.locations.tuningJobs.operations.wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done." }, "cancel": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string", "description": "The name of the operation resource to be cancelled.", "location": "path" } }, "httpMethod": "POST", "id": "aiplatform.projects.locations.tuningJobs.operations.cancel", "path": "v1beta1/{+name}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", "id": "aiplatform.projects.locations.tuningJobs.operations.get", "path": "v1beta1/{+name}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "The name of the operation resource.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", "type": "string", "location": "path" } } } } } } }, "batchPredictionJobs": { "methods": { "create": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "description": "Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}`", "type": "string", "location": "path" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob" }, "httpMethod": "POST", "path": "v1beta1/{+parent}/batchPredictionJobs", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob" }, "description": "Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.batchPredictionJobs.create" }, "get": { "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.batchPredictionJobs.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$", "location": "path", "description": "Required. The name of the BatchPredictionJob resource. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", "type": "string", "required": true } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}", "httpMethod": "GET", "description": "Gets a BatchPredictionJob", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob" } }, "cancel": { "httpMethod": "POST", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "description": "Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$" } }, "id": "aiplatform.projects.locations.batchPredictionJobs.cancel", "request": { "$ref": "GoogleCloudAiplatformV1beta1CancelBatchPredictionJobRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to `CANCELLED`. Any files already outputted by the job are not deleted.", "path": "v1beta1/{+name}:cancel", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}:cancel" }, "list": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1ListBatchPredictionJobsResponse" }, "path": "v1beta1/{+parent}/batchPredictionJobs", "id": "aiplatform.projects.locations.batchPredictionJobs.list", "parameterOrder": [ "parent" ], "description": "Lists BatchPredictionJobs in a Location.", "parameters": { "filter": { "type": "string", "location": "query", "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`\u003c`, `\u003c=`,`\u003e`, `\u003e=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time\u003e\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`" }, "pageSize": { "type": "integer", "format": "int32", "description": "The standard list page size.", "location": "query" }, "readMask": { "type": "string", "location": "query", "description": "Mask specifying which fields to read.", "format": "google-fieldmask" }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call." }, "parent": { "required": true, "type": "string", "description": "Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project}/locations/{location}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" } }, "httpMethod": "GET" }, "delete": { "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}", "description": "Deletes a BatchPredictionJob. Can only be called on jobs that already finished.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "description": "Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$" } }, "httpMethod": "DELETE", "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.batchPredictionJobs.delete" } } }, "ragEngineConfig": { "resources": { "operations": { "methods": { "wait": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "id": "aiplatform.projects.locations.ragEngineConfig.operations.wait", "parameters": { "timeout": { "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "location": "query" }, "name": { "required": true, "description": "The name of the operation resource to wait on.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "path": "v1beta1/{+name}:wait", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:wait" }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}", "path": "v1beta1/{+name}", "httpMethod": "GET", "id": "aiplatform.projects.locations.ragEngineConfig.operations.get", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", "location": "path", "description": "The name of the operation resource.", "required": true } } }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "id": "aiplatform.projects.locations.ragEngineConfig.operations.list", "parameters": { "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", "required": true, "type": "string", "location": "path", "description": "The name of the operation's parent resource." }, "pageSize": { "location": "query", "format": "int32", "description": "The standard list page size.", "type": "integer" }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." } }, "path": "v1beta1/{+name}/operations", "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameters": { "name": { "location": "path", "type": "string", "required": true, "description": "The name of the operation resource to be deleted.", "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$" } }, "httpMethod": "DELETE", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.ragEngineConfig.operations.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "cancel": { "id": "aiplatform.projects.locations.ragEngineConfig.operations.cancel", "path": "v1beta1/{+name}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:cancel", "httpMethod": "POST", "parameterOrder": [ "name" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", "location": "path", "required": true, "type": "string", "description": "The name of the operation resource to be cancelled." } }, "response": { "$ref": "GoogleProtobufEmpty" } } } } } }, "evaluationItems": { "resources": { "operations": { "methods": { "delete": { "parameters": { "name": { "required": true, "type": "string", "location": "path", "description": "The name of the operation resource to be deleted.", "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+/operations/[^/]+$" } }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations/{operationsId}", "parameterOrder": [ "name" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.evaluationItems.operations.delete", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" } }, "wait": { "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.evaluationItems.operations.wait", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations/{operationsId}:wait", "parameters": { "name": { "type": "string", "location": "path", "required": true, "description": "The name of the operation resource to wait on.", "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+/operations/[^/]+$" }, "timeout": { "location": "query", "format": "google-duration", "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done." }, "get": { "id": "aiplatform.projects.locations.evaluationItems.operations.get", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations/{operationsId}", "path": "v1beta1/{+name}", "httpMethod": "GET", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource.", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "list": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations", "parameters": { "pageSize": { "location": "query", "type": "integer", "description": "The standard list page size.", "format": "int32" }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", "required": true, "type": "string", "description": "The name of the operation's parent resource.", "location": "path" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" } }, "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameterOrder": [ "name" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.evaluationItems.operations.list" } } } }, "methods": { "list": { "id": "aiplatform.projects.locations.evaluationItems.list", "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems", "parameters": { "parent": { "description": "Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project}/locations/{location}`", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" }, "filter": { "location": "query", "type": "string", "description": "Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160)." }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "Optional. The maximum number of Evaluation Items to return." }, "pageToken": { "location": "query", "description": "Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page.", "type": "string" }, "orderBy": { "type": "string", "location": "query", "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending." } }, "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/evaluationItems", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListEvaluationItemsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Evaluation Items." }, "delete": { "parameters": { "name": { "description": "Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", "type": "string", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.evaluationItems.delete", "httpMethod": "DELETE", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}", "parameterOrder": [ "name" ], "description": "Deletes an Evaluation Item.", "response": { "$ref": "GoogleLongrunningOperation" } }, "create": { "description": "Creates an Evaluation Item.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems", "path": "v1beta1/{+parent}/evaluationItems", "httpMethod": "POST", "response": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationItem" }, "parameters": { "parent": { "description": "Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project}/locations/{location}`", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "id": "aiplatform.projects.locations.evaluationItems.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationItem" }, "parameterOrder": [ "parent" ] }, "get": { "response": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationItem" }, "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}", "parameterOrder": [ "name" ], "description": "Gets an Evaluation Item.", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.evaluationItems.get", "parameters": { "name": { "description": "Required. The name of the EvaluationItem resource. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", "type": "string", "required": true } } } } }, "solvers": { "resources": { "operations": { "methods": { "delete": { "parameterOrder": [ "name" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations/{operationsId}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.solvers.operations.delete", "parameters": { "name": { "required": true, "description": "The name of the operation resource to be deleted.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+/operations/[^/]+$" } } }, "get": { "httpMethod": "GET", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+/operations/[^/]+$", "required": true, "location": "path", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations/{operationsId}", "id": "aiplatform.projects.locations.solvers.operations.get", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" } }, "list": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "pageSize": { "description": "The standard list page size.", "type": "integer", "location": "query", "format": "int32" }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation's parent resource.", "required": true } }, "id": "aiplatform.projects.locations.solvers.operations.list", "parameterOrder": [ "name" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1beta1/{+name}/operations" } } } } }, "agents": { "resources": { "operations": { "methods": { "wait": { "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}:wait", "id": "aiplatform.projects.locations.agents.operations.wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to wait on." }, "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "format": "google-duration", "type": "string" } }, "parameterOrder": [ "name" ], "httpMethod": "POST", "path": "v1beta1/{+name}:wait" }, "cancel": { "path": "v1beta1/{+name}:cancel", "id": "aiplatform.projects.locations.agents.operations.cancel", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$" } }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." }, "get": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.agents.operations.get", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "location": "path", "description": "The name of the operation resource.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}", "httpMethod": "GET" }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}/operations", "parameterOrder": [ "name" ], "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations", "parameters": { "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "The standard list page size." }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", "type": "string", "description": "The name of the operation's parent resource.", "required": true }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } }, "id": "aiplatform.projects.locations.agents.operations.list", "response": { "$ref": "GoogleLongrunningListOperationsResponse" } }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.agents.operations.delete", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to be deleted.", "type": "string", "location": "path" } } } } } }, "methods": { "getIamPolicy": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}:getIamPolicy", "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleIamV1Policy" }, "parameters": { "options.requestedPolicyVersion": { "format": "int32", "location": "query", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer" }, "resource": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", "location": "path", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." } }, "httpMethod": "POST", "id": "aiplatform.projects.locations.agents.getIamPolicy", "parameterOrder": [ "resource" ], "path": "v1beta1/{+resource}:getIamPolicy" }, "create": { "parameterOrder": [ "parent" ], "id": "aiplatform.projects.locations.agents.create", "description": "Creates an agent.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents", "httpMethod": "POST", "path": "v1beta1/{+parent}/agents", "request": { "$ref": "GoogleCloudAiplatformV1beta1Agent" }, "parameters": { "parent": { "location": "path", "type": "string", "description": "Required. The resource name of the location to create the agent in. Format: `projects/{project}/locations/{location}`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" } }, "list": { "parameters": { "pageToken": { "description": "Optional. A page token, received from a previous AgentService.ListAgents call. Provide this to retrieve the subsequent page.", "type": "string", "location": "query" }, "orderBy": { "description": "Optional. A comma-separated list of fields to order by. Supported fields: * `created` * `updated` Use `desc` after a field name for descending order. Example: `created desc`.", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. The maximum number of agents to return. The service may return fewer than this value. The maximum page size is 100; values above 100 will be coerced to 100. If unspecified, the default page size is 10.", "location": "query", "format": "int32", "type": "integer" }, "parent": { "description": "Required. The resource name of the location to list agents from. Format: `projects/{project}/locations/{location}`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "location": "path" }, "filter": { "description": "Optional. An [AIP-160](https://google.aip.dev/160) filter over the returned agents. An empty filter returns the unfiltered collection. Supported fields, and the operators each accepts: * `created` * `updated` * `base_agent` * `metadata.agent_type` `created` and `updated` are timestamps and take an RFC-3339 value, for example `2026-08-01T00:00:00Z`. Supported operators: `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, `\u003e=`, `:`, `AND`, `OR`, `NOT` (equivalently `-`), and parentheses. Note that `OR` binds more tightly than `AND`, so `a AND b OR c` means `a AND (b OR c)`; parentheses are recommended, not required. `metadata.agent_type` accepts only the value `\"default_agent\"`, matched exactly: `metadata.agent_type:\"default_agent\"` selects the caller's default agent, of which there is at most one, and the negated form selects the rest. Any other value is `INVALID_ARGUMENT` rather than an empty page -- `metadata` is an opaque blob, so only this one marker is indexed, and the server cannot answer a question about the others. An agent designated before the server began recording the marker is not matched by the positive form; there is no backfill. `base_agent` accepts `=` and `!=` against the value an agent was created with, and selects only among the agents you own: an agent that belongs to the project rather than to a user is never returned by a filter naming it, including the negated form. An agent created before the server began recording the value is not matched either. Example: `created \u003e \"2026-08-01T00:00:00Z\" AND updated \u003c \"2026-08-09T00:00:00Z\"`. IMPORTANT -- `base_agent` and `metadata.agent_type` select only among the agents you own. An agent that belongs to the project rather than to a user is never returned by a filter naming either of them, including a negated one: `base_agent != \"some-value\"` returns your matching agents and no project-owned agents at all. Filtering on `created` or `updated` alone is unaffected and still spans both. If you want every agent in the project, do not filter on these two fields. Not supported: any field other than those listed above, wildcards other than `field:*`, bare literals with no field name, functions, and the regular-expression operators `=~` and `!~`. A filter that names an unsupported field, exceeds 1000 characters, or nests parentheses more than 5 deep fails with `INVALID_ARGUMENT`.", "type": "string", "location": "query" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1ListAgentsResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents", "path": "v1beta1/{+parent}/agents", "description": "Lists the agents in a location that belong to the caller. An agent belongs to the end user recorded as its owner when it was created, so the response holds that caller's agents and no others. It is empty for a caller that is not an end user, and an agent with no recorded owner is listed for nobody.", "id": "aiplatform.projects.locations.agents.list" }, "setIamPolicy": { "path": "v1beta1/{+resource}:setIamPolicy", "parameterOrder": [ "resource" ], "id": "aiplatform.projects.locations.agents.setIamPolicy", "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleIamV1Policy" }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}:setIamPolicy", "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "parameters": { "resource": { "location": "path", "type": "string", "required": true, "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$" } } }, "delete": { "parameters": { "name": { "type": "string", "location": "path", "description": "Required. The resource name of the agent to delete. Format: `projects/{project}/locations/{location}/agents/{agent}`.", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", "required": true }, "force": { "type": "boolean", "description": "Optional. If true, any `Task` belonging to this agent is deleted along with it. If false or unset and the agent still has at least one `Task`, the request fails with `FAILED_PRECONDITION` and nothing is deleted. This governs `Task` and nothing else. Resources the agent owns but a caller never named -- its AI Application and the tenant project bound to it, its Workspace identity, its service-extension binding -- are torn down with the agent on every delete, whatever this field says.", "location": "query" } }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Deletes an agent.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}", "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.agents.delete" }, "get": { "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}", "id": "aiplatform.projects.locations.agents.get", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The resource name of the agent to retrieve. Format: `projects/{project}/locations/{location}/agents/{agent}`.", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$" } }, "description": "Retrieves an agent.", "response": { "$ref": "GoogleCloudAiplatformV1beta1Agent" } }, "patch": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", "location": "path", "description": "Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.", "type": "string", "required": true }, "updateMask": { "type": "string", "format": "google-fieldmask", "description": "Optional. The list of fields to update. If not present, all fields are updated.", "location": "query" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1Agent" }, "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudAiplatformV1beta1Agent" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}", "description": "Updates an agent.", "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.agents.patch", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "testIamPermissions": { "parameterOrder": [ "resource" ], "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}:testIamPermissions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "path": "v1beta1/{+resource}:testIamPermissions", "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "type": "string", "required": true }, "permissions": { "type": "string", "repeated": true, "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", "location": "query" } }, "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "id": "aiplatform.projects.locations.agents.testIamPermissions" } } }, "nasJobs": { "resources": { "nasTrialDetails": { "methods": { "get": { "httpMethod": "GET", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleCloudAiplatformV1beta1NasTrialDetail" }, "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+/nasTrialDetails/[^/]+$", "description": "Required. The name of the NasTrialDetail resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}`" } }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails/{nasTrialDetailsId}", "id": "aiplatform.projects.locations.nasJobs.nasTrialDetails.get", "description": "Gets a NasTrialDetail.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "parameterOrder": [ "parent" ], "httpMethod": "GET", "parameters": { "pageToken": { "location": "query", "type": "string", "description": "The standard list page token. Typically obtained via ListNasTrialDetailsResponse.next_page_token of the previous JobService.ListNasTrialDetails call." }, "pageSize": { "format": "int32", "description": "The standard list page size.", "type": "integer", "location": "query" }, "parent": { "type": "string", "location": "path", "description": "Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`", "pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$", "required": true } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1ListNasTrialDetailsResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+parent}/nasTrialDetails", "description": "List top NasTrialDetails of a NasJob.", "id": "aiplatform.projects.locations.nasJobs.nasTrialDetails.list" } } } }, "methods": { "delete": { "id": "aiplatform.projects.locations.nasJobs.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "httpMethod": "DELETE", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}", "parameters": { "name": { "required": true, "description": "Required. The name of the NasJob resource to be deleted. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "description": "Deletes a NasJob." }, "list": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The resource name of the Location to list the NasJobs from. Format: `projects/{project}/locations/{location}`" }, "pageSize": { "format": "int32", "type": "integer", "location": "query", "description": "The standard list page size." }, "filter": { "location": "query", "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`\u003c`, `\u003c=`,`\u003e`, `\u003e=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time\u003e\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", "type": "string" }, "readMask": { "type": "string", "format": "google-fieldmask", "location": "query", "description": "Mask specifying which fields to read." }, "pageToken": { "type": "string", "description": "The standard list page token. Typically obtained via ListNasJobsResponse.next_page_token of the previous JobService.ListNasJobs call.", "location": "query" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1ListNasJobsResponse" }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "description": "Lists NasJobs in a Location.", "id": "aiplatform.projects.locations.nasJobs.list", "path": "v1beta1/{+parent}/nasJobs" }, "create": { "path": "v1beta1/{+parent}/nasJobs", "id": "aiplatform.projects.locations.nasJobs.create", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a NasJob", "response": { "$ref": "GoogleCloudAiplatformV1beta1NasJob" }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1NasJob" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The resource name of the Location to create the NasJob in. Format: `projects/{project}/locations/{location}`", "required": true, "type": "string" } } }, "cancel": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.nasJobs.cancel", "request": { "$ref": "GoogleCloudAiplatformV1beta1CancelNasJobRequest" }, "description": "Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and NasJob.state is set to `CANCELLED`.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}:cancel", "path": "v1beta1/{+name}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The name of the NasJob to cancel. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`" } }, "httpMethod": "POST" }, "get": { "parameterOrder": [ "name" ], "description": "Gets a NasJob", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleCloudAiplatformV1beta1NasJob" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$", "description": "Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`", "type": "string", "required": true, "location": "path" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "id": "aiplatform.projects.locations.nasJobs.get" } } }, "featureGroups": { "resources": { "features": { "methods": { "list": { "description": "Lists Features in a given FeatureGroup.", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features", "id": "aiplatform.projects.locations.featureGroups.features.list", "parameters": { "parent": { "description": "Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", "required": true, "location": "path", "type": "string" }, "orderBy": { "location": "query", "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`", "type": "string" }, "latestStatsCount": { "type": "integer", "format": "int32", "description": "Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists \u003c ListFeaturesRequest.latest_stats_count, return all existing stats.", "location": "query" }, "filter": { "description": "Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, \u003c, \u003e, \u003e=, and \u003c= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, \u003c, \u003e, \u003e=, and \u003c= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --\u003e Features whose type is DOUBLE. * `create_time \u003e \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time \u003e \\\"2020-01-31T15:30:00.000000Z\\\"` --\u003e EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\u003e Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\u003e Any Feature which has a label with 'env' as the key.", "type": "string", "location": "query" }, "readMask": { "description": "Mask specifying which fields to read.", "location": "query", "type": "string", "format": "google-fieldmask" }, "pageSize": { "format": "int32", "location": "query", "description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", "type": "integer" }, "pageToken": { "description": "A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token.", "location": "query", "type": "string" } }, "path": "v1beta1/{+parent}/features", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListFeaturesResponse" }, "parameterOrder": [ "parent" ] }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1Feature" }, "id": "aiplatform.projects.locations.featureGroups.features.patch", "description": "Updates the parameters of a single Feature.", "path": "v1beta1/{+name}", "httpMethod": "PATCH", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", "location": "path", "description": "Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.", "required": true, "type": "string" }, "updateMask": { "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)", "type": "string", "format": "google-fieldmask", "location": "query" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" } }, "delete": { "id": "aiplatform.projects.locations.featureGroups.features.delete", "path": "v1beta1/{+name}", "description": "Deletes a single Feature.", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", "description": "Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", "httpMethod": "DELETE" }, "get": { "response": { "$ref": "GoogleCloudAiplatformV1beta1Feature" }, "description": "Gets details of a single Feature.", "httpMethod": "GET", "id": "aiplatform.projects.locations.featureGroups.features.get", "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", "description": "Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`" }, "featureStatsAndAnomalySpec.statsTimeRange.endTime": { "location": "query", "format": "google-datetime", "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", "type": "string" }, "featureStatsAndAnomalySpec.latestStatsCount": { "format": "int32", "description": "Optional. If set, returns the most recent count of stats. Valid value is [0, 100]. If stats_time_range is set, return most recent count of stats within the stats_time_range.", "type": "integer", "location": "query" }, "featureStatsAndAnomalySpec.statsTimeRange.startTime": { "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", "location": "query", "type": "string", "format": "google-datetime" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", "parameterOrder": [ "name" ] }, "batchCreate": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features:batchCreate", "httpMethod": "POST", "id": "aiplatform.projects.locations.featureGroups.features.batchCreate", "parameters": { "parent": { "type": "string", "location": "path", "required": true, "description": "Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`", "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$" } }, "parameterOrder": [ "parent" ], "description": "Creates a batch of Features in a given FeatureGroup.", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+parent}/features:batchCreate", "request": { "$ref": "GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "request": { "$ref": "GoogleCloudAiplatformV1beta1Feature" }, "parameters": { "parent": { "required": true, "type": "string", "description": "Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$" }, "featureId": { "type": "string", "description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.", "location": "query" } }, "path": "v1beta1/{+parent}/features", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "parent" ], "id": "aiplatform.projects.locations.featureGroups.features.create", "description": "Creates a new Feature in a given FeatureGroup." } }, "resources": { "operations": { "methods": { "wait": { "id": "aiplatform.projects.locations.featureGroups.features.operations.wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "httpMethod": "POST", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "timeout": { "format": "google-duration", "type": "string", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." }, "name": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to wait on.", "location": "path" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait", "path": "v1beta1/{+name}:wait" }, "get": { "path": "v1beta1/{+name}", "httpMethod": "GET", "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", "type": "string", "required": true, "description": "The name of the operation resource." } }, "id": "aiplatform.projects.locations.featureGroups.features.operations.get", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", "path": "v1beta1/{+name}", "httpMethod": "DELETE", "id": "aiplatform.projects.locations.featureGroups.features.operations.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "type": "string", "location": "path", "description": "The name of the operation resource to be deleted.", "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$" } }, "parameterOrder": [ "name" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." }, "list": { "httpMethod": "GET", "parameters": { "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", "type": "string", "description": "The name of the operation's parent resource.", "location": "path" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "returnPartialSuccess": { "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query" }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "The standard list page size." } }, "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.featureGroups.features.operations.list", "path": "v1beta1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } } } } }, "operations": { "methods": { "wait": { "id": "aiplatform.projects.locations.featureGroups.operations.wait", "httpMethod": "POST", "parameters": { "timeout": { "type": "string", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration" }, "name": { "location": "path", "description": "The name of the operation resource to wait on.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$" } }, "path": "v1beta1/{+name}:wait", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done." }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}", "id": "aiplatform.projects.locations.featureGroups.operations.delete", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}", "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "location": "path" } } }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1beta1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations", "httpMethod": "GET", "id": "aiplatform.projects.locations.featureGroups.operations.list", "parameters": { "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "name": { "required": true, "description": "The name of the operation's parent resource.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", "location": "path" }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "The standard list page size." } }, "parameterOrder": [ "name" ] }, "get": { "id": "aiplatform.projects.locations.featureGroups.operations.get", "httpMethod": "GET", "parameters": { "name": { "location": "path", "type": "string", "description": "The name of the operation resource.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "GoogleLongrunningOperation" } } } }, "featureMonitors": { "resources": { "operations": { "methods": { "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.list", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations", "path": "v1beta1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "name": { "location": "path", "description": "The name of the operation's parent resource.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$" }, "pageSize": { "type": "integer", "description": "The standard list page size.", "format": "int32", "location": "query" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" } } }, "delete": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "description": "The name of the operation resource to be deleted.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$" } }, "id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.delete", "httpMethod": "DELETE" }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}:wait", "httpMethod": "POST", "parameters": { "timeout": { "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration", "location": "query" }, "name": { "location": "path", "description": "The name of the operation resource to wait on.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}:wait" }, "get": { "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$", "description": "The name of the operation resource.", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.get", "path": "v1beta1/{+name}" } } }, "featureMonitorJobs": { "methods": { "get": { "id": "aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.get", "parameters": { "name": { "description": "Required. The name of the FeatureMonitorJob resource. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job}`", "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/featureMonitorJobs/[^/]+$", "required": true, "type": "string", "location": "path" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitorJob" }, "description": "Get a feature monitor job.", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs/{featureMonitorJobsId}" }, "create": { "response": { "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitorJob" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+parent}/featureMonitorJobs", "request": { "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitorJob" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs", "description": "Creates a new feature monitor job.", "id": "aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.create", "parameterOrder": [ "parent" ], "httpMethod": "POST", "parameters": { "featureMonitorJobId": { "format": "int64", "description": "Optional. Output only. System-generated ID for feature monitor job.", "type": "string", "location": "query" }, "parent": { "description": "Required. The resource name of FeatureMonitor to create FeatureMonitorJob. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", "type": "string" } } }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "pageToken": { "description": "Optional. A page token, received from a previous FeatureRegistryService.ListFeatureMonitorJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureMonitorJobs must match the call that provided the page token.", "type": "string", "location": "query" }, "orderBy": { "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time`", "location": "query", "type": "string" }, "parent": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", "location": "path", "description": "Required. The resource name of the FeatureMonitor to list FeatureMonitorJobs. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`" }, "filter": { "location": "query", "type": "string", "description": "Optional. Lists the FeatureMonitorJobs that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, and `\u003e=` comparisons. Values must be Examples: * `create_time \u003e \"2020-01-01\"` FeatureMonitorJobs created after 2020-01-01." }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "Optional. The maximum number of FeatureMonitorJobs to return. The service may return fewer than this value. If unspecified, at most 100 FeatureMonitorJobs will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100." } }, "id": "aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.list", "description": "List feature monitor jobs.", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListFeatureMonitorJobsResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs", "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/featureMonitorJobs" } } } }, "methods": { "patch": { "description": "Updates the parameters of a single FeatureMonitor.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}", "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitor" }, "id": "aiplatform.projects.locations.featureGroups.featureMonitors.patch", "parameterOrder": [ "name" ], "httpMethod": "PATCH", "parameters": { "updateMask": { "location": "query", "type": "string", "description": "Optional. Field mask is used to specify the fields to be overwritten in the FeatureMonitor resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `schedule_config` * `feature_selection_config`", "format": "google-fieldmask" }, "name": { "required": true, "description": "Identifier. Name of the FeatureMonitor. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}/featureMonitors/{featureMonitor}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", "type": "string" } } }, "create": { "path": "v1beta1/{+parent}/featureMonitors", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitor" }, "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors", "id": "aiplatform.projects.locations.featureGroups.featureMonitors.create", "parameterOrder": [ "parent" ], "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", "required": true, "type": "string", "description": "Required. The resource name of FeatureGroup to create FeatureMonitor. Format: `projects/{project}/locations/{location}/featureGroups/{featuregroup}`", "location": "path" }, "featureMonitorId": { "description": "Required. The ID to use for this FeatureMonitor, which will become the final component of the FeatureGroup's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the FeatureGroup.", "type": "string", "location": "query" } }, "description": "Creates a new FeatureMonitor in a given project, location and FeatureGroup." }, "get": { "httpMethod": "GET", "parameters": { "name": { "location": "path", "description": "Required. The name of the FeatureMonitor resource.", "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", "type": "string", "required": true } }, "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}", "description": "Gets details of a single FeatureMonitor.", "response": { "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitor" }, "id": "aiplatform.projects.locations.featureGroups.featureMonitors.get", "parameterOrder": [ "name" ] }, "delete": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}", "id": "aiplatform.projects.locations.featureGroups.featureMonitors.delete", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", "type": "string", "description": "Required. The name of the FeatureMonitor to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`", "required": true, "location": "path" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "DELETE", "description": "Deletes a single FeatureMonitor.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}" }, "list": { "parameters": { "parent": { "location": "path", "type": "string", "required": true, "description": "Required. The resource name of the FeatureGroup to list FeatureMonitors. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`", "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$" }, "pageSize": { "format": "int32", "location": "query", "description": "Optional. The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureMonitors will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", "type": "integer" }, "orderBy": { "type": "string", "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`", "location": "query" }, "filter": { "description": "Optional. Lists the FeatureMonitors that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, and `\u003e=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, and `\u003e=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \u003e \"2020-01-01\" OR update_time \u003e \"2020-01-01\"` FeatureMonitors created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureGroups with label \"env\" set to \"prod\".", "type": "string", "location": "query" }, "pageToken": { "description": "Optional. A page token, received from a previous FeatureRegistryService.ListFeatureMonitors call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureMonitors must match the call that provided the page token.", "location": "query", "type": "string" } }, "httpMethod": "GET", "id": "aiplatform.projects.locations.featureGroups.featureMonitors.list", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListFeatureMonitorsResponse" }, "path": "v1beta1/{+parent}/featureMonitors", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists FeatureGroups in a given project and location.", "parameterOrder": [ "parent" ] } } } }, "methods": { "patch": { "path": "v1beta1/{+name}", "request": { "$ref": "GoogleCloudAiplatformV1beta1FeatureGroup" }, "id": "aiplatform.projects.locations.featureGroups.patch", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the parameters of a single FeatureGroup.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", "type": "string", "location": "path", "description": "Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`", "required": true }, "updateMask": { "description": "Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type`", "format": "google-fieldmask", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "PATCH" }, "get": { "description": "Gets details of a single FeatureGroup.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.featureGroups.get", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", "response": { "$ref": "GoogleCloudAiplatformV1beta1FeatureGroup" }, "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", "description": "Required. The name of the FeatureGroup resource.", "required": true, "location": "path", "type": "string" } } }, "testIamPermissions": { "httpMethod": "POST", "path": "v1beta1/{+resource}:testIamPermissions", "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "parameters": { "permissions": { "location": "query", "repeated": true, "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", "type": "string" }, "resource": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." } }, "id": "aiplatform.projects.locations.featureGroups.testIamPermissions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:testIamPermissions", "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "parameterOrder": [ "resource" ] }, "delete": { "httpMethod": "DELETE", "path": "v1beta1/{+name}", "parameters": { "force": { "type": "boolean", "location": "query", "description": "If set to true, any Features under this FeatureGroup will also be deleted. (Otherwise, the request will only work if the FeatureGroup has no Features.)" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", "location": "path", "description": "Required. The name of the FeatureGroup to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", "required": true, "type": "string" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.featureGroups.delete", "parameterOrder": [ "name" ], "description": "Deletes a single FeatureGroup.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "description": "Creates a new FeatureGroup in a given project and location.", "path": "v1beta1/{+parent}/featureGroups", "request": { "$ref": "GoogleCloudAiplatformV1beta1FeatureGroup" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project}/locations/{location}`", "type": "string", "location": "path" }, "featureGroupId": { "type": "string", "location": "query", "description": "Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location." } }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "id": "aiplatform.projects.locations.featureGroups.create", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups" }, "getIamPolicy": { "parameterOrder": [ "resource" ], "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "path": "v1beta1/{+resource}:getIamPolicy", "httpMethod": "POST", "parameters": { "resource": { "type": "string", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", "required": true, "location": "path" }, "options.requestedPolicyVersion": { "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer", "location": "query" } }, "response": { "$ref": "GoogleIamV1Policy" }, "id": "aiplatform.projects.locations.featureGroups.getIamPolicy", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:getIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "response": { "$ref": "GoogleCloudAiplatformV1beta1ListFeatureGroupsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+parent}/featureGroups", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups", "description": "Lists FeatureGroups in a given project and location.", "id": "aiplatform.projects.locations.featureGroups.list", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project}/locations/{location}`", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "pageToken": { "description": "A page token, received from a previous FeatureRegistryService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureGroups must match the call that provided the page token.", "type": "string", "location": "query" }, "pageSize": { "type": "integer", "location": "query", "description": "The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", "format": "int32" }, "orderBy": { "type": "string", "location": "query", "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`" }, "filter": { "location": "query", "description": "Lists the FeatureGroups that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, and `\u003e=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, and `\u003e=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \u003e \"2020-01-01\" OR update_time \u003e \"2020-01-01\"` FeatureGroups created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureGroups with label \"env\" set to \"prod\".", "type": "string" } }, "parameterOrder": [ "parent" ] }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:setIamPolicy", "response": { "$ref": "GoogleIamV1Policy" }, "id": "aiplatform.projects.locations.featureGroups.setIamPolicy", "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "httpMethod": "POST", "parameterOrder": [ "resource" ], "path": "v1beta1/{+resource}:setIamPolicy", "parameters": { "resource": { "required": true, "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", "location": "path", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "dataLabelingJobs": { "resources": { "operations": { "methods": { "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameterOrder": [ "name" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations", "httpMethod": "GET", "id": "aiplatform.projects.locations.dataLabelingJobs.operations.list", "parameters": { "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "name": { "location": "path", "type": "string", "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", "required": true }, "pageSize": { "description": "The standard list page size.", "type": "integer", "location": "query", "format": "int32" } }, "path": "v1beta1/{+name}/operations" }, "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.dataLabelingJobs.operations.delete", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource to be deleted.", "location": "path" } }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "httpMethod": "DELETE" }, "wait": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameters": { "timeout": { "type": "string", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration" }, "name": { "description": "The name of the operation resource to wait on.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", "type": "string", "location": "path" } }, "path": "v1beta1/{+name}:wait", "id": "aiplatform.projects.locations.dataLabelingJobs.operations.wait", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait" }, "cancel": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "path": "v1beta1/{+name}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path", "description": "The name of the operation resource to be cancelled." } }, "id": "aiplatform.projects.locations.dataLabelingJobs.operations.cancel" }, "get": { "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.dataLabelingJobs.operations.get", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", "type": "string", "location": "path", "description": "The name of the operation resource." } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." } } } }, "methods": { "create": { "parameterOrder": [ "parent" ], "description": "Creates a DataLabelingJob.", "response": { "$ref": "GoogleCloudAiplatformV1beta1DataLabelingJob" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1DataLabelingJob" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs", "parameters": { "parent": { "description": "Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path" } }, "id": "aiplatform.projects.locations.dataLabelingJobs.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "path": "v1beta1/{+parent}/dataLabelingJobs" }, "cancel": { "request": { "$ref": "GoogleCloudAiplatformV1beta1CancelDataLabelingJobRequest" }, "description": "Cancels a DataLabelingJob. Success of cancellation is not guaranteed.", "id": "aiplatform.projects.locations.dataLabelingJobs.cancel", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "POST", "parameters": { "name": { "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", "description": "Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}:cancel" }, "get": { "parameterOrder": [ "name" ], "description": "Gets a DataLabelingJob.", "id": "aiplatform.projects.locations.dataLabelingJobs.get", "path": "v1beta1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", "location": "path", "type": "string", "description": "Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`", "required": true } }, "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1DataLabelingJob" } }, "list": { "response": { "$ref": "GoogleCloudAiplatformV1beta1ListDataLabelingJobsResponse" }, "parameterOrder": [ "parent" ], "parameters": { "filter": { "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`\u003c`, `\u003c=`,`\u003e`, `\u003e=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time\u003e\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", "location": "query", "type": "string" }, "orderBy": { "location": "query", "type": "string", "description": "A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending." }, "readMask": { "format": "google-fieldmask", "type": "string", "description": "Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be `paths: \"name\"`. The \"name\" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned.", "location": "query" }, "parent": { "type": "string", "location": "path", "description": "Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "pageSize": { "type": "integer", "location": "query", "description": "The standard list page size.", "format": "int32" } }, "id": "aiplatform.projects.locations.dataLabelingJobs.list", "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs", "description": "Lists DataLabelingJobs in a Location.", "path": "v1beta1/{+parent}/dataLabelingJobs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "description": "Deletes a DataLabelingJob.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.dataLabelingJobs.delete", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the DataLabelingJob to be deleted. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "DELETE" } } }, "servingProfiles": { "resources": { "operations": { "methods": { "cancel": { "id": "aiplatform.projects.locations.servingProfiles.operations.cancel", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be cancelled.", "location": "path" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}:cancel", "httpMethod": "POST", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}/operations/{operationsId}:cancel" }, "list": { "parameters": { "filter": { "type": "string", "description": "The standard list filter.", "location": "query" }, "pageSize": { "type": "integer", "description": "The standard list page size.", "location": "query", "format": "int32" }, "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+$", "required": true, "description": "The name of the operation's parent resource.", "location": "path", "type": "string" }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." } }, "id": "aiplatform.projects.locations.servingProfiles.operations.list", "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1beta1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}/operations" }, "wait": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}/operations/{operationsId}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "timeout": { "location": "query", "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration" }, "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to wait on.", "type": "string" } }, "id": "aiplatform.projects.locations.servingProfiles.operations.wait", "path": "v1beta1/{+name}:wait", "httpMethod": "POST" }, "delete": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}/operations/{operationsId}", "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "required": true, "type": "string", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.servingProfiles.operations.delete", "path": "v1beta1/{+name}" }, "get": { "path": "v1beta1/{+name}", "httpMethod": "GET", "id": "aiplatform.projects.locations.servingProfiles.operations.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+/operations/[^/]+$", "required": true, "type": "string", "description": "The name of the operation resource.", "location": "path" } }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}/operations/{operationsId}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" } } } } }, "methods": { "create": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Creates a ServingProfile.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1ServingProfile" }, "path": "v1beta1/{+parent}/servingProfiles", "httpMethod": "POST", "parameters": { "servingProfileId": { "description": "Required. The ID to use for the ServingProfile, which will become the final component of the ServingProfile's resource name. This value should be 1-63 characters, and valid characters are `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.", "location": "query", "type": "string" }, "parent": { "required": true, "description": "Required. The resource name of the Location to create the ServingProfile in. Format: `projects/{project}/locations/{location}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "type": "string" } }, "id": "aiplatform.projects.locations.servingProfiles.create", "parameterOrder": [ "parent" ] }, "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.projects.locations.servingProfiles.delete", "description": "Deletes a ServingProfile.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+$", "description": "Required. The name of the ServingProfile resource to be deleted. Format: `projects/{project}/locations/{location}/servingProfiles/{serving_profile}`", "required": true } }, "path": "v1beta1/{+name}", "httpMethod": "DELETE" }, "get": { "httpMethod": "GET", "path": "v1beta1/{+name}", "description": "Gets a ServingProfile.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+$", "description": "Required. The name of the ServingProfile resource. Format: `projects/{project}/locations/{location}/servingProfiles/{serving_profile}`", "location": "path", "type": "string", "required": true } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1ServingProfile" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}", "id": "aiplatform.projects.locations.servingProfiles.get" }, "list": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles", "parameterOrder": [ "parent" ], "id": "aiplatform.projects.locations.servingProfiles.list", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListServingProfilesResponse" }, "path": "v1beta1/{+parent}/servingProfiles", "httpMethod": "GET", "parameters": { "pageToken": { "description": "Optional. The standard list page token.", "location": "query", "type": "string" }, "parent": { "required": true, "description": "Required. The resource name of the Location to list the ServingProfiles from. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "pageSize": { "location": "query", "description": "Optional. The standard list page size. If unspecified, at most 100 ServingProfiles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "type": "integer", "format": "int32" } }, "description": "Lists ServingProfiles in a Location.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "id": "aiplatform.projects.locations.servingProfiles.patch", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}", "response": { "$ref": "GoogleCloudAiplatformV1beta1ServingProfile" }, "parameters": { "updateMask": { "description": "Optional. The list of fields to update; see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. If omitted, all populated (non-empty) mutable fields are updated; if set to `[\"*\"]`, all mutable fields are fully replaced (unpopulated values are cleared).", "type": "string", "format": "google-fieldmask", "location": "query" }, "name": { "description": "Identifier. The resource name of the ServingProfile.", "pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+$", "location": "path", "type": "string", "required": true } }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1ServingProfile" }, "path": "v1beta1/{+name}", "description": "Updates a ServingProfile." } } }, "semanticGovernancePolicyEngine": { "methods": { "deprovision": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicyEngine$", "description": "Required. The resource name of the SemanticGovernancePolicyEngine to deprovision. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine", "required": true, "type": "string", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1DeprovisionSemanticGovernancePolicyEngineRequest" }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine:deprovision", "id": "aiplatform.projects.locations.semanticGovernancePolicyEngine.deprovision", "description": "Deprovisions the SemanticGovernancePolicyEngine, tearing down the associated tenant project, GKE cluster, and PSC service attachments. This operation is irreversible. Returns a long-running operation; poll for completion. The response contains the SemanticGovernancePolicyEngine in DEPROVISIONING state.", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}:deprovision" } } }, "extensions": { "methods": { "delete": { "parameterOrder": [ "name" ], "description": "Deletes an Extension.", "id": "aiplatform.projects.locations.extensions.delete", "httpMethod": "DELETE", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", "required": true, "description": "Required. The name of the Extension resource to be deleted. Format: `projects/{project}/locations/{location}/extensions/{extension}`", "location": "path", "type": "string" } }, "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" } }, "patch": { "description": "Updates an Extension.", "request": { "$ref": "GoogleCloudAiplatformV1beta1Extension" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "response": { "$ref": "GoogleCloudAiplatformV1beta1Extension" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}", "httpMethod": "PATCH", "id": "aiplatform.projects.locations.extensions.patch", "parameters": { "updateMask": { "location": "query", "description": "Required. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `runtime_config` * `tool_use_examples` * `manifest.description`", "format": "google-fieldmask", "type": "string" }, "name": { "required": true, "description": "Identifier. The resource name of the Extension.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$" } } }, "query": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}:query", "path": "v1beta1/{+name}:query", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1QueryExtensionResponse" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1QueryExtensionRequest" }, "id": "aiplatform.projects.locations.extensions.query", "description": "Queries an extension with a default controller.", "httpMethod": "POST", "parameters": { "name": { "description": "Required. Name (identifier) of the extension; Format: `projects/{project}/locations/{location}/extensions/{extension}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", "location": "path" } } }, "execute": { "path": "v1beta1/{+name}:execute", "id": "aiplatform.projects.locations.extensions.execute", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "description": "Required. Name (identifier) of the extension; Format: `projects/{project}/locations/{location}/extensions/{extension}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", "type": "string" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1ExecuteExtensionResponse" }, "httpMethod": "POST", "description": "Executes the request against a given extension.", "request": { "$ref": "GoogleCloudAiplatformV1beta1ExecuteExtensionRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}:execute" }, "get": { "httpMethod": "GET", "parameters": { "name": { "location": "path", "type": "string", "description": "Required. The name of the Extension resource. Format: `projects/{project}/locations/{location}/extensions/{extension}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1Extension" }, "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}", "description": "Gets an Extension.", "id": "aiplatform.projects.locations.extensions.get" }, "import": { "parameters": { "parent": { "description": "Required. The resource name of the Location to import the Extension in. Format: `projects/{project}/locations/{location}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path" } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1Extension" }, "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions:import", "parameterOrder": [ "parent" ], "description": "Imports an Extension.", "id": "aiplatform.projects.locations.extensions.import", "path": "v1beta1/{+parent}/extensions:import", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "id": "aiplatform.projects.locations.extensions.list", "parameters": { "parent": { "required": true, "description": "Required. The resource name of the Location to list the Extensions from. Format: `projects/{project}/locations/{location}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path" }, "pageSize": { "location": "query", "description": "Optional. The standard list page size.", "format": "int32", "type": "integer" }, "orderBy": { "location": "query", "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", "type": "string" }, "pageToken": { "type": "string", "description": "Optional. The standard list page token.", "location": "query" }, "filter": { "type": "string", "location": "query", "description": "Optional. The standard list filter. Supported fields: * `display_name` * `create_time` * `update_time` More detail in [AIP-160](https://google.aip.dev/160)." } }, "description": "Lists Extensions in a location.", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions", "path": "v1beta1/{+parent}/extensions", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1ListExtensionsResponse" } } }, "resources": { "operations": { "methods": { "wait": { "path": "v1beta1/{+name}:wait", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to wait on.", "type": "string" }, "timeout": { "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration", "location": "query" } }, "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.extensions.operations.wait", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}:wait" }, "get": { "id": "aiplatform.projects.locations.extensions.operations.get", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}", "parameters": { "name": { "type": "string", "required": true, "location": "path", "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$" } } }, "cancel": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$", "required": true, "type": "string", "description": "The name of the operation resource to be cancelled.", "location": "path" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:cancel", "id": "aiplatform.projects.locations.extensions.operations.cancel" }, "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "id": "aiplatform.projects.locations.extensions.operations.list", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "pageSize": { "type": "integer", "location": "query", "description": "The standard list page size.", "format": "int32" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "name": { "description": "The name of the operation's parent resource.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$" }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." } }, "path": "v1beta1/{+name}/operations" }, "delete": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "The name of the operation resource to be deleted.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$" } }, "httpMethod": "DELETE", "id": "aiplatform.projects.locations.extensions.operations.delete", "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." } } } } }, "customJobs": { "resources": { "operations": { "methods": { "delete": { "httpMethod": "DELETE", "path": "v1beta1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to be deleted.", "type": "string", "location": "path" } }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.customJobs.operations.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ] }, "list": { "parameters": { "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "name": { "required": true, "type": "string", "location": "path", "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$" }, "pageSize": { "location": "query", "format": "int32", "description": "The standard list page size.", "type": "integer" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" } }, "path": "v1beta1/{+name}/operations", "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.customJobs.operations.list", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations" }, "get": { "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "id": "aiplatform.projects.locations.customJobs.operations.get", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}", "parameters": { "name": { "location": "path", "type": "string", "description": "The name of the operation resource.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "path": "v1beta1/{+name}" }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "path": "v1beta1/{+name}:wait", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.customJobs.operations.wait", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:wait", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", "type": "string", "required": true, "description": "The name of the operation resource to wait on." }, "timeout": { "type": "string", "format": "google-duration", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." } }, "httpMethod": "POST" }, "cancel": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be cancelled.", "required": true, "type": "string" } }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "httpMethod": "POST", "path": "v1beta1/{+name}:cancel", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.projects.locations.customJobs.operations.cancel" } } } }, "methods": { "cancel": { "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.customJobs.cancel", "description": "Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetCustomJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and CustomJob.state is set to `CANCELLED`.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}:cancel", "request": { "$ref": "GoogleCloudAiplatformV1beta1CancelCustomJobRequest" }, "path": "v1beta1/{+name}:cancel", "parameterOrder": [ "name" ], "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the CustomJob to cancel. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", "required": true } } }, "create": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs", "path": "v1beta1/{+parent}/customJobs", "description": "Creates a CustomJob. A created CustomJob right away will be attempted to be run.", "httpMethod": "POST", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1CustomJob" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "description": "Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`", "location": "path" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1CustomJob" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.customJobs.create" }, "get": { "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.customJobs.get", "httpMethod": "GET", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", "description": "Required. The name of the CustomJob resource. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`", "location": "path", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1CustomJob" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}", "description": "Gets a CustomJob.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "id": "aiplatform.projects.locations.customJobs.delete", "description": "Deletes a CustomJob.", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", "location": "path", "description": "Required. The name of the CustomJob resource to be deleted. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`", "type": "string", "required": true } }, "httpMethod": "DELETE" }, "list": { "id": "aiplatform.projects.locations.customJobs.list", "description": "Lists CustomJobs in a Location.", "parameters": { "filter": { "location": "query", "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`\u003c`, `\u003c=`,`\u003e`, `\u003e=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time\u003e\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", "type": "string" }, "pageSize": { "description": "The standard list page size.", "format": "int32", "type": "integer", "location": "query" }, "readMask": { "format": "google-fieldmask", "type": "string", "description": "Mask specifying which fields to read.", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The resource name of the Location to list the CustomJobs from. Format: `projects/{project}/locations/{location}`", "type": "string", "required": true, "location": "path" } }, "httpMethod": "GET", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListCustomJobsResponse" }, "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/customJobs", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs" } } }, "evaluationSets": { "resources": { "operations": { "methods": { "wait": { "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:wait", "httpMethod": "POST", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "id": "aiplatform.projects.locations.evaluationSets.operations.wait", "parameters": { "name": { "location": "path", "type": "string", "description": "The name of the operation resource to wait on.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+/operations/[^/]+$" }, "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "type": "string", "format": "google-duration" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/operations/{operationsId}:wait" }, "delete": { "path": "v1beta1/{+name}", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "type": "string" } }, "id": "aiplatform.projects.locations.evaluationSets.operations.delete", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/operations/{operationsId}", "id": "aiplatform.projects.locations.evaluationSets.operations.get", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "parameters": { "name": { "required": true, "description": "The name of the operation resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+/operations/[^/]+$", "type": "string" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "GET" }, "list": { "path": "v1beta1/{+name}/operations", "parameters": { "name": { "description": "The name of the operation's parent resource.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", "location": "path" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "pageSize": { "format": "int32", "type": "integer", "location": "query", "description": "The standard list page size." }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" } }, "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/operations", "id": "aiplatform.projects.locations.evaluationSets.operations.list", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "response": { "$ref": "GoogleLongrunningListOperationsResponse" } } } } }, "methods": { "patch": { "response": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationSet" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationSet" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", "id": "aiplatform.projects.locations.evaluationSets.patch", "parameters": { "updateMask": { "format": "google-fieldmask", "description": "Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.", "location": "query", "type": "string" }, "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", "location": "path", "description": "Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`" } }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "description": "Updates an Evaluation Set." }, "delete": { "id": "aiplatform.projects.locations.evaluationSets.delete", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "description": "Required. The name of the EvaluationSet resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", "required": true, "type": "string" } }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes an Evaluation Set.", "path": "v1beta1/{+name}" }, "create": { "parameterOrder": [ "parent" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets", "path": "v1beta1/{+parent}/evaluationSets", "response": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationSet" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.evaluationSets.create", "description": "Creates an Evaluation Set.", "request": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationSet" }, "parameters": { "parent": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The resource name of the Location to create the Evaluation Set in. Format: `projects/{project}/locations/{location}`", "required": true } }, "httpMethod": "POST" }, "import": { "parameters": { "parent": { "description": "Required. Parent resource name.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, "description": "Imports an Evaluation Set.", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets:import", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/evaluationSets:import", "id": "aiplatform.projects.locations.evaluationSets.import", "request": { "$ref": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequest" } }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+parent}/evaluationSets", "id": "aiplatform.projects.locations.evaluationSets.list", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets", "parameters": { "pageSize": { "type": "integer", "location": "query", "description": "Optional. The maximum number of Evaluation Sets to return.", "format": "int32" }, "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "description": "Required. The resource name of the Location from which to list the Evaluation Sets. Format: `projects/{project}/locations/{location}`" }, "pageToken": { "location": "query", "description": "Optional. A page token, received from a previous `ListEvaluationSets` call. Provide this to retrieve the subsequent page.", "type": "string" }, "orderBy": { "type": "string", "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", "location": "query" }, "filter": { "location": "query", "type": "string", "description": "Optional. Filter expression that matches a subset of the EvaluationSets to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160)." } }, "description": "Lists Evaluation Sets.", "parameterOrder": [ "parent" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListEvaluationSetsResponse" } }, "get": { "path": "v1beta1/{+name}", "response": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationSet" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "description": "Gets an Evaluation Set.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", "location": "path", "type": "string", "description": "Required. The name of the EvaluationSet resource. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", "required": true } }, "id": "aiplatform.projects.locations.evaluationSets.get", "parameterOrder": [ "name" ] } } }, "modelDeploymentMonitoringJobs": { "resources": { "operations": { "methods": { "list": { "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}/operations", "parameters": { "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" }, "name": { "required": true, "type": "string", "description": "The name of the operation's parent resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$" }, "pageSize": { "format": "int32", "description": "The standard list page size.", "type": "integer", "location": "query" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } }, "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.list" }, "cancel": { "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be cancelled.", "location": "path", "type": "string", "required": true } }, "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.cancel", "parameterOrder": [ "name" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." }, "wait": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.wait", "parameters": { "name": { "description": "The name of the operation resource to wait on.", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "type": "string" }, "timeout": { "type": "string", "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait", "httpMethod": "POST" }, "get": { "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.get", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "type": "string", "required": true, "location": "path", "description": "The name of the operation resource." } }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "path": "v1beta1/{+name}", "parameters": { "name": { "location": "path", "type": "string", "description": "The name of the operation resource to be deleted.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$" } }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "httpMethod": "DELETE", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.delete", "response": { "$ref": "GoogleProtobufEmpty" } } } } }, "methods": { "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "required": true, "description": "Required. The resource name of the model monitoring job to delete. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$" } }, "httpMethod": "DELETE", "description": "Deletes a ModelDeploymentMonitoringJob.", "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}" }, "get": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", "required": true, "description": "Required. The resource name of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`", "location": "path" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob" }, "description": "Gets a ModelDeploymentMonitoringJob.", "httpMethod": "GET", "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.get", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ] }, "searchModelDeploymentMonitoringStatsAnomalies": { "description": "Searches Model Monitoring Statistics generated within a given time window.", "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.searchModelDeploymentMonitoringStatsAnomalies", "request": { "$ref": "GoogleCloudAiplatformV1beta1SearchModelDeploymentMonitoringStatsAnomaliesRequest" }, "httpMethod": "POST", "parameters": { "modelDeploymentMonitoringJob": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", "description": "Required. ModelDeploymentMonitoring Job resource name. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1SearchModelDeploymentMonitoringStatsAnomaliesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+modelDeploymentMonitoringJob}:searchModelDeploymentMonitoringStatsAnomalies", "parameterOrder": [ "modelDeploymentMonitoringJob" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies" }, "list": { "path": "v1beta1/{+parent}/modelDeploymentMonitoringJobs", "parameterOrder": [ "parent" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs", "description": "Lists ModelDeploymentMonitoringJobs in a Location.", "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.list", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1ListModelDeploymentMonitoringJobsResponse" }, "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`", "required": true }, "readMask": { "type": "string", "location": "query", "description": "Mask specifying which fields to read", "format": "google-fieldmask" }, "pageSize": { "type": "integer", "location": "query", "description": "The standard list page size.", "format": "int32" }, "filter": { "type": "string", "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`\u003c`, `\u003c=`,`\u003e`, `\u003e=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time\u003e\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", "location": "query" }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." } } }, "pause": { "request": { "$ref": "GoogleCloudAiplatformV1beta1PauseModelDeploymentMonitoringJobRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'.", "parameters": { "name": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", "description": "Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`" } }, "path": "v1beta1/{+name}:pause", "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:pause", "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.pause", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" } }, "patch": { "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "parameters": { "updateMask": { "description": "Required. The update mask is used to specify the fields to be overwritten in the ModelDeploymentMonitoringJob resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. For the objective config, the user can either provide the update mask for model_deployment_monitoring_objective_configs or any combination of its nested fields, such as: model_deployment_monitoring_objective_configs.objective_config.training_dataset. Updatable fields: * `display_name` * `model_deployment_monitoring_schedule_config` * `model_monitoring_alert_config` * `logging_sampling_strategy` * `labels` * `log_ttl` * `enable_monitoring_pipeline_logs` . and * `model_deployment_monitoring_objective_configs` . or * `model_deployment_monitoring_objective_configs.objective_config.training_dataset` * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config` * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config`", "type": "string", "format": "google-fieldmask", "location": "query" }, "name": { "location": "path", "type": "string", "required": true, "description": "Output only. Resource name of a ModelDeploymentMonitoringJob.", "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}", "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.patch", "request": { "$ref": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob" }, "description": "Updates a ModelDeploymentMonitoringJob." }, "resume": { "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.resume", "path": "v1beta1/{+name}:resume", "description": "Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:resume", "parameters": { "name": { "description": "Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", "location": "path", "required": true } }, "response": { "$ref": "GoogleProtobufEmpty" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1ResumeModelDeploymentMonitoringJobRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST" }, "create": { "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.create", "response": { "$ref": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob" }, "parameterOrder": [ "parent" ], "parameters": { "parent": { "required": true, "type": "string", "location": "path", "description": "Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "path": "v1beta1/{+parent}/modelDeploymentMonitoringJobs", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs", "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval." } } }, "interactions": { "methods": { "delete": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions/{interactionsId}", "response": { "$ref": "GenaiVertexV1beta1DeleteInteractionResponse" }, "description": "Deletes an interaction.", "id": "aiplatform.projects.locations.interactions.delete", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "required": true, "description": "Required. The name of the interaction to delete. Format: interactions/{interaction}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/interactions/[^/]+$" } } }, "createStream": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions:createStream", "path": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions:createStream", "parameterOrder": [ "projectsId", "locationsId" ], "response": { "$ref": "GenaiVertexV1beta1InteractionStreamingEvent" }, "description": "Creates an interaction and streams the response.", "httpMethod": "POST", "request": { "$ref": "GenaiVertexV1beta1CreateInteractionRequest" }, "id": "aiplatform.projects.locations.interactions.createStream", "parameters": { "projectsId": { "type": "string", "location": "path", "required": true }, "locationsId": { "location": "path", "required": true, "type": "string" } } }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GenaiVertexV1beta1CreateInteractionRequest" }, "response": { "$ref": "GenaiVertexV1beta1Interaction" }, "description": "Creates an interaction.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions:create", "parameterOrder": [ "projectsId", "locationsId" ], "path": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions:create", "id": "aiplatform.projects.locations.interactions.create", "parameters": { "locationsId": { "type": "string", "location": "path", "required": true }, "projectsId": { "type": "string", "location": "path", "required": true } }, "httpMethod": "POST" } } }, "taskStores": { "resources": { "a2aTaskRecords": { "resources": { "events": { "methods": { "list": { "response": { "$ref": "GoogleCloudAiplatformV1beta1ListA2ATaskRecordEventsResponse" }, "parameterOrder": [ "parent" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/a2aTaskRecords/{a2aTaskRecordsId}/events", "description": "Lists TaskEvents for an A2ATaskRecord.", "httpMethod": "GET", "parameters": { "pageToken": { "description": "Optional. The next_page_token value returned from a previous list A2ATaskRecordService.ListA2ATaskRecordEvents call.", "location": "query", "type": "string" }, "filter": { "type": "string", "description": "Optional. The standard list filter. Supported fields: * `create_time` range (i.e. `create_time\u003e=\"2025-01-31T11:30:00-04:00\"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160).", "location": "query" }, "orderBy": { "type": "string", "location": "query", "description": "Optional. A comma-separated list of fields to order the results by. If this field is omitted, the results will be ordered by `generation` in ascending order. For each field, the default sort order is ascending. To specify descending order for a field, append a ` desc` suffix. For example: `create_time desc`. Supported fields: * `create_time` * `generation`" }, "parent": { "required": true, "description": "Required. The resource name of the A2ATaskRecord to list the TaskEvents under. Format: `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTaskRecords/{a2a_task_record}`", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+/a2aTaskRecords/[^/]+$" }, "pageSize": { "type": "integer", "location": "query", "description": "Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. The maximum value is 100; values above 100 will be coerced to 100.", "format": "int32" } }, "path": "v1beta1/{+parent}/events", "id": "aiplatform.projects.locations.taskStores.a2aTaskRecords.events.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } }, "methods": { "get": { "response": { "$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecord" }, "id": "aiplatform.projects.locations.taskStores.a2aTaskRecords.get", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/a2aTaskRecords/{a2aTaskRecordsId}", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+/a2aTaskRecords/[^/]+$", "location": "path", "description": "Required. The resource name of the A2ATaskRecord. Format: `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTaskRecords/{a2a_task_record}`", "required": true }, "view": { "description": "Optional. The view of the A2ATaskRecord to return.", "enumDescriptions": [ "Task view unspecified.", "Task header only (status, metadata, timestamps)", "Full materialized state (artifacts + history)" ], "enum": [ "A2A_TASK_RECORD_VIEW_UNSPECIFIED", "A2A_TASK_RECORD_VIEW_BASIC", "A2A_TASK_RECORD_VIEW_FULL" ], "location": "query", "type": "string" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets an A2ATaskRecord." }, "appendEvents": { "path": "v1beta1/{+name}:appendEvents", "request": { "$ref": "GoogleCloudAiplatformV1beta1AppendA2ATaskRecordEventsRequest" }, "parameters": { "name": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+/a2aTaskRecords/[^/]+$", "description": "Required. The resource name of the A2ATaskRecord to append events to. Format: `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTaskRecords/{a2a_task_record}`", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1AppendA2ATaskRecordEventsResponse" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/a2aTaskRecords/{a2aTaskRecordsId}:appendEvents", "description": "Appends A2ATaskRecordEvents to an A2ATaskRecord.", "id": "aiplatform.projects.locations.taskStores.a2aTaskRecords.appendEvents" }, "delete": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+/a2aTaskRecords/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name of the A2ATaskRecord to delete. Format: `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTaskRecords/{a2a_task_record}`", "required": true } }, "httpMethod": "DELETE", "id": "aiplatform.projects.locations.taskStores.a2aTaskRecords.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes an A2ATaskRecord.", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/a2aTaskRecords/{a2aTaskRecordsId}", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecord" } }, "create": { "response": { "$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecord" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates an A2ATaskRecord.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/a2aTaskRecords", "parameterOrder": [ "parent" ], "id": "aiplatform.projects.locations.taskStores.a2aTaskRecords.create", "parameters": { "a2aTaskRecordId": { "location": "query", "description": "Optional. The user defined ID to use for the A2ATaskRecord, which will become the final component of the A2ATaskRecord resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number.", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+$", "location": "path", "description": "Required. The resource name of the TaskStore to create the A2ATaskRecord under. Format: `projects/{project}/locations/{location}/taskStores/{task_store}`", "type": "string", "required": true } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecord" }, "path": "v1beta1/{+parent}/a2aTaskRecords", "httpMethod": "POST" }, "list": { "description": "Lists A2ATaskRecords in a TaskStore.", "parameters": { "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "Optional. The maximum number of tasks to return. The service may return fewer than this value. If unspecified, at most 10 tasks will be returned. The maximum value is 100; values above 100 will be coerced to 100." }, "filter": { "type": "string", "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `context_id` * `status.state` Example: `context_id=\"abc\"`, `status.state=\"WORKING\"`.", "location": "query" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list A2ATaskRecordService.ListA2ATaskRecords call.", "location": "query", "type": "string" }, "parent": { "required": true, "type": "string", "location": "path", "description": "Required. The resource name of the TaskStore to list the A2ATaskRecords under. Format: `projects/{project}/locations/{location}/taskStores/{task_store}`", "pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+$" }, "orderBy": { "location": "query", "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. If this field is omitted, the default ordering is `create_time` descending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time` Example: `create_time desc`.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListA2ATaskRecordsResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/a2aTaskRecords", "path": "v1beta1/{+parent}/a2aTaskRecords", "id": "aiplatform.projects.locations.taskStores.a2aTaskRecords.list" } } }, "operations": { "methods": { "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "location": "path", "type": "string", "required": true } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/operations/{operationsId}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.taskStores.operations.delete", "path": "v1beta1/{+name}" }, "wait": { "path": "v1beta1/{+name}:wait", "httpMethod": "POST", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to wait on.", "location": "path" }, "timeout": { "type": "string", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration" } }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/operations/{operationsId}:wait", "id": "aiplatform.projects.locations.taskStores.operations.wait", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ] }, "get": { "httpMethod": "GET", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/operations/{operationsId}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.taskStores.operations.get", "path": "v1beta1/{+name}" }, "list": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}/operations", "id": "aiplatform.projects.locations.taskStores.operations.list", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameters": { "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "returnPartialSuccess": { "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query" }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "pageSize": { "type": "integer", "description": "The standard list page size.", "location": "query", "format": "int32" }, "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+$", "description": "The name of the operation's parent resource." } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "httpMethod": "GET" }, "cancel": { "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "id": "aiplatform.projects.locations.taskStores.operations.cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/operations/{operationsId}:cancel", "httpMethod": "POST", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation resource to be cancelled." } }, "path": "v1beta1/{+name}:cancel" } } } } }, "featurestores": { "methods": { "searchFeatures": { "path": "v1beta1/{+location}/featurestores:searchFeatures", "response": { "$ref": "GoogleCloudAiplatformV1beta1SearchFeaturesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores:searchFeatures", "parameterOrder": [ "location" ], "parameters": { "query": { "description": "Query string that is a conjunction of field-restricted queries and/or field-restricted filters. Field-restricted queries and filters can be combined using `AND` to form a conjunction. A field query is in the form FIELD:QUERY. This implicitly checks if QUERY exists as a substring within Feature's FIELD. The QUERY and the FIELD are converted to a sequence of words (i.e. tokens) for comparison. This is done by: * Removing leading/trailing whitespace and tokenizing the search value. Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated as a wildcard that matches characters within a token. * Ignoring case. * Prepending an asterisk to the first and appending an asterisk to the last token in QUERY. A QUERY must be either a singular token or a phrase. A phrase is one or multiple words enclosed in double quotation marks (\"). With phrases, the order of the words is important. Words in the phrase must be matching in order and consecutively. Supported FIELDs for field-restricted queries: * `feature_id` * `description` * `entity_type_id` Examples: * `feature_id: foo` --\u003e Matches a Feature with ID containing the substring `foo` (eg. `foo`, `foofeature`, `barfoo`). * `feature_id: foo*feature` --\u003e Matches a Feature with ID containing the substring `foo*feature` (eg. `foobarfeature`). * `feature_id: foo AND description: bar` --\u003e Matches a Feature with ID containing the substring `foo` and description containing the substring `bar`. Besides field queries, the following exact-match filters are supported. The exact-match filters do not support wildcards. Unlike field-restricted queries, exact-match filters are case-sensitive. * `feature_id`: Supports = comparisons. * `description`: Supports = comparisons. Multi-token filters should be enclosed in quotes. * `entity_type_id`: Supports = comparisons. * `value_type`: Supports = and != comparisons. * `labels`: Supports key-value equality as well as key presence. * `featurestore_id`: Supports = comparisons. Examples: * `description = \"foo bar\"` --\u003e Any Feature with description exactly equal to `foo bar` * `value_type = DOUBLE` --\u003e Features whose type is DOUBLE. * `labels.active = yes AND labels.env = prod` --\u003e Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\u003e Any Feature which has a label with `env` as the key.", "location": "query", "type": "string" }, "pageSize": { "format": "int32", "location": "query", "description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 100 Features will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", "type": "integer" }, "pageToken": { "location": "query", "description": "A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.SearchFeatures, except `page_size`, must match the call that provided the page token.", "type": "string" }, "location": { "location": "path", "description": "Required. The resource name of the Location to search Features. Format: `projects/{project}/locations/{location}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, "id": "aiplatform.projects.locations.featurestores.searchFeatures", "httpMethod": "GET", "description": "Searches Features matching a query in a given project." }, "getIamPolicy": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "request": { "$ref": "GoogleIamV1GetIamPolicyRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:getIamPolicy", "httpMethod": "POST", "parameterOrder": [ "resource" ], "path": "v1beta1/{+resource}:getIamPolicy", "response": { "$ref": "GoogleIamV1Policy" }, "parameters": { "resource": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." } }, "id": "aiplatform.projects.locations.featurestores.getIamPolicy" }, "get": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The name of the Featurestore resource." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "httpMethod": "GET", "id": "aiplatform.projects.locations.featurestores.get", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}", "response": { "$ref": "GoogleCloudAiplatformV1beta1Featurestore" }, "path": "v1beta1/{+name}", "description": "Gets details of a single Featurestore." }, "create": { "path": "v1beta1/{+parent}/featurestores", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.featurestores.create", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "featurestoreId": { "location": "query", "type": "string", "description": "Required. The ID to use for this Featurestore, which will become the final component of the Featurestore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path", "description": "Required. The resource name of the Location to create Featurestores. Format: `projects/{project}/locations/{location}`", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1Featurestore" }, "description": "Creates a new Featurestore in a given project and location." }, "delete": { "description": "Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed.", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}", "parameters": { "force": { "description": "If set to true, any EntityTypes and Features for this Featurestore will also be deleted. (Otherwise, the request will only work if the Featurestore has no EntityTypes.)", "location": "query", "type": "boolean" }, "name": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", "description": "Required. The name of the Featurestore to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`" } }, "id": "aiplatform.projects.locations.featurestores.delete", "response": { "$ref": "GoogleLongrunningOperation" } }, "list": { "response": { "$ref": "GoogleCloudAiplatformV1beta1ListFeaturestoresResponse" }, "httpMethod": "GET", "description": "Lists Featurestores in a given project and location.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores", "parameters": { "pageSize": { "description": "The maximum number of Featurestores to return. The service may return fewer than this value. If unspecified, at most 100 Featurestores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { "type": "string", "location": "query", "description": "A page token, received from a previous FeaturestoreService.ListFeaturestores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores must match the call that provided the page token." }, "filter": { "description": "Lists the featurestores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, and `\u003e=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, and `\u003e=` comparisons. Values must be in RFC 3339 format. * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, and `\u003e=` comparisons. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \u003e \"2020-01-01\" OR update_time \u003e \"2020-01-01\"` Featurestores created or updated after 2020-01-01. * `labels.env = \"prod\"` Featurestores with label \"env\" set to \"prod\".", "type": "string", "location": "query" }, "readMask": { "description": "Mask specifying which fields to read.", "type": "string", "format": "google-fieldmask", "location": "query" }, "orderBy": { "location": "query", "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time` * `online_serving_config.fixed_node_count`", "type": "string" }, "parent": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The resource name of the Location to list Featurestores. Format: `projects/{project}/locations/{location}`", "location": "path" } }, "path": "v1beta1/{+parent}/featurestores", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.featurestores.list", "parameterOrder": [ "parent" ] }, "batchReadFeatureValues": { "httpMethod": "POST", "parameterOrder": [ "featurestore" ], "path": "v1beta1/{+featurestore}:batchReadFeatureValues", "parameters": { "featurestore": { "description": "Required. The resource name of the Featurestore from which to query Feature values. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", "location": "path", "required": true } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1BatchReadFeatureValuesRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:batchReadFeatureValues", "id": "aiplatform.projects.locations.featurestores.batchReadFeatureValues", "description": "Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { "response": { "$ref": "GoogleIamV1Policy" }, "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+resource}:setIamPolicy", "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:setIamPolicy", "parameters": { "resource": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", "location": "path", "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "type": "string" } }, "id": "aiplatform.projects.locations.featurestores.setIamPolicy", "parameterOrder": [ "resource" ] }, "patch": { "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1Featurestore" }, "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}", "parameters": { "name": { "description": "Output only. Name of the Featurestore. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$" }, "updateMask": { "location": "query", "format": "google-fieldmask", "type": "string", "description": "Field mask is used to specify the fields to be overwritten in the Featurestore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `online_serving_config.fixed_node_count` * `online_serving_config.scaling` * `online_storage_ttl_days`" } }, "httpMethod": "PATCH", "description": "Updates the parameters of a single Featurestore.", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.featurestores.patch" }, "testIamPermissions": { "path": "v1beta1/{+resource}:testIamPermissions", "request": { "$ref": "GoogleIamV1TestIamPermissionsRequest" }, "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.featurestores.testIamPermissions", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:testIamPermissions", "httpMethod": "POST", "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", "location": "path", "required": true } }, "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" } } }, "resources": { "operations": { "methods": { "cancel": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path" } }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.projects.locations.featurestores.operations.cancel", "path": "v1beta1/{+name}:cancel" }, "get": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource.", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.featurestores.operations.get", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}" }, "list": { "id": "aiplatform.projects.locations.featurestores.operations.list", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1beta1/{+name}/operations", "parameters": { "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", "type": "string", "description": "The name of the operation's parent resource." }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "pageSize": { "type": "integer", "format": "int32", "description": "The standard list page size.", "location": "query" }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" } }, "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ] }, "delete": { "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.featurestores.operations.delete", "parameters": { "name": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted." } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "wait": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:wait", "parameters": { "timeout": { "type": "string", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", "required": true, "type": "string", "description": "The name of the operation resource to wait on.", "location": "path" } }, "id": "aiplatform.projects.locations.featurestores.operations.wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "path": "v1beta1/{+name}:wait" } } }, "entityTypes": { "resources": { "operations": { "methods": { "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations", "path": "v1beta1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.list", "parameters": { "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "The standard list page size." }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "type": "string", "required": true, "description": "The name of the operation's parent resource.", "location": "path" } }, "httpMethod": "GET", "parameterOrder": [ "name" ] }, "wait": { "parameterOrder": [ "name" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "path": "v1beta1/{+name}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait", "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.wait", "parameters": { "timeout": { "format": "google-duration", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string" }, "name": { "required": true, "description": "The name of the operation resource to wait on.", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", "location": "path", "type": "string" } }, "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" } }, "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.cancel", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "name": { "required": true, "type": "string", "location": "path", "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$" } } }, "delete": { "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "type": "string", "required": true } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "httpMethod": "GET", "parameters": { "name": { "required": true, "location": "path", "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", "type": "string" } }, "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.get", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } } }, "features": { "methods": { "list": { "path": "v1beta1/{+parent}/features", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListFeaturesResponse" }, "description": "Lists Features in a given EntityType.", "parameters": { "latestStatsCount": { "type": "integer", "location": "query", "format": "int32", "description": "Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists \u003c ListFeaturesRequest.latest_stats_count, return all existing stats." }, "pageToken": { "description": "A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token.", "type": "string", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "location": "path", "description": "Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", "required": true, "type": "string" }, "readMask": { "description": "Mask specifying which fields to read.", "type": "string", "format": "google-fieldmask", "location": "query" }, "pageSize": { "type": "integer", "location": "query", "description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", "format": "int32" }, "filter": { "location": "query", "type": "string", "description": "Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, \u003c, \u003e, \u003e=, and \u003c= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, \u003c, \u003e, \u003e=, and \u003c= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --\u003e Features whose type is DOUBLE. * `create_time \u003e \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time \u003e \\\"2020-01-31T15:30:00.000000Z\\\"` --\u003e EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\u003e Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\u003e Any Feature which has a label with 'env' as the key." }, "orderBy": { "type": "string", "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`", "location": "query" } }, "id": "aiplatform.projects.locations.featurestores.entityTypes.features.list", "httpMethod": "GET" }, "create": { "httpMethod": "POST", "path": "v1beta1/{+parent}/features", "parameters": { "featureId": { "type": "string", "location": "query", "description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup." }, "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`" } }, "parameterOrder": [ "parent" ], "description": "Creates a new Feature in a given EntityType.", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.featurestores.entityTypes.features.create", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features", "request": { "$ref": "GoogleCloudAiplatformV1beta1Feature" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "httpMethod": "PATCH", "path": "v1beta1/{+name}", "parameters": { "name": { "type": "string", "location": "path", "description": "Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$" }, "updateMask": { "location": "query", "type": "string", "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)", "format": "google-fieldmask" } }, "description": "Updates the parameters of a single Feature.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.featurestores.entityTypes.features.patch", "request": { "$ref": "GoogleCloudAiplatformV1beta1Feature" }, "response": { "$ref": "GoogleCloudAiplatformV1beta1Feature" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}" }, "batchCreate": { "httpMethod": "POST", "id": "aiplatform.projects.locations.featurestores.entityTypes.features.batchCreate", "parameters": { "parent": { "description": "Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "location": "path", "type": "string", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+parent}/features:batchCreate", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features:batchCreate", "description": "Creates a batch of Features in a given EntityType.", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest" } }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single Feature.", "parameters": { "featureStatsAndAnomalySpec.statsTimeRange.startTime": { "format": "google-datetime", "type": "string", "location": "query", "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start." }, "featureStatsAndAnomalySpec.latestStatsCount": { "type": "integer", "description": "Optional. If set, returns the most recent count of stats. Valid value is [0, 100]. If stats_time_range is set, return most recent count of stats within the stats_time_range.", "format": "int32", "location": "query" }, "name": { "type": "string", "required": true, "description": "Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$" }, "featureStatsAndAnomalySpec.statsTimeRange.endTime": { "format": "google-datetime", "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", "type": "string", "location": "query" } }, "httpMethod": "GET", "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.featurestores.entityTypes.features.get", "response": { "$ref": "GoogleCloudAiplatformV1beta1Feature" }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}" }, "delete": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}", "description": "Deletes a single Feature.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "location": "path", "required": true, "description": "Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "DELETE", "id": "aiplatform.projects.locations.featurestores.entityTypes.features.delete", "path": "v1beta1/{+name}" } }, "resources": { "operations": { "methods": { "cancel": { "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.cancel", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be cancelled.", "type": "string", "required": true } }, "path": "v1beta1/{+name}:cancel", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "wait": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "path": "v1beta1/{+name}:wait", "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.wait", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to wait on.", "type": "string", "required": true }, "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "location": "query", "format": "google-duration" } }, "parameterOrder": [ "name" ], "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait" }, "list": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.list", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation's parent resource.", "required": true }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "The standard list page size." } }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v1beta1/{+name}/operations" }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.get", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "parameters": { "name": { "description": "The name of the operation resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", "type": "string", "required": true } }, "httpMethod": "GET" }, "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}", "httpMethod": "DELETE", "path": "v1beta1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path", "description": "The name of the operation resource to be deleted." } }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.delete" } } } } } }, "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1EntityType" }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}", "id": "aiplatform.projects.locations.featurestores.entityTypes.get", "description": "Gets details of a single EntityType.", "httpMethod": "GET", "parameters": { "name": { "location": "path", "description": "Required. The name of the EntityType resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true } } }, "list": { "id": "aiplatform.projects.locations.featurestores.entityTypes.list", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists EntityTypes in a given Featurestore.", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListEntityTypesResponse" }, "httpMethod": "GET", "path": "v1beta1/{+parent}/entityTypes", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes", "parameters": { "filter": { "type": "string", "location": "query", "description": "Lists the EntityTypes that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003e=`, and `\u003c=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003e=`, and `\u003c=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time \u003e \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time \u003e \\\"2020-01-31T15:30:00.000000Z\\\"` --\u003e EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\u003e EntityTypes having both (active: yes) and (env: prod) labels. * `labels.env: *` --\u003e Any EntityType which has a label with 'env' as the key." }, "orderBy": { "type": "string", "location": "query", "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `entity_type_id` * `create_time` * `update_time`" }, "pageToken": { "description": "A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token.", "location": "query", "type": "string" }, "readMask": { "type": "string", "description": "Mask specifying which fields to read.", "location": "query", "format": "google-fieldmask" }, "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", "description": "Required. The resource name of the Featurestore to list EntityTypes. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", "location": "path", "type": "string" }, "pageSize": { "format": "int32", "description": "The maximum number of EntityTypes to return. The service may return fewer than this value. If unspecified, at most 1000 EntityTypes will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", "type": "integer", "location": "query" } } }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:testIamPermissions", "httpMethod": "POST", "path": "v1beta1/{+resource}:testIamPermissions", "parameters": { "permissions": { "repeated": true, "type": "string", "location": "query", "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions)." }, "resource": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path" } }, "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "id": "aiplatform.projects.locations.featurestores.entityTypes.testIamPermissions" }, "delete": { "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.featurestores.entityTypes.delete", "httpMethod": "DELETE", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string", "description": "Required. The name of the EntityType to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", "location": "path" }, "force": { "type": "boolean", "location": "query", "description": "If set to true, any Features for this EntityType will also be deleted. (Otherwise, the request will only work if the EntityType has no Features.)" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}", "description": "Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed." }, "streamingReadFeatureValues": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:streamingReadFeatureValues", "id": "aiplatform.projects.locations.featurestores.entityTypes.streamingReadFeatureValues", "parameterOrder": [ "entityType" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponse" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1StreamingReadFeatureValuesRequest" }, "description": "Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.", "path": "v1beta1/{+entityType}:streamingReadFeatureValues", "parameters": { "entityType": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "description": "Required. The resource name of the entities' type. Value format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.", "type": "string", "required": true } }, "httpMethod": "POST" }, "readFeatureValues": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1ReadFeatureValuesRequest" }, "path": "v1beta1/{+entityType}:readFeatureValues", "httpMethod": "POST", "id": "aiplatform.projects.locations.featurestores.entityTypes.readFeatureValues", "response": { "$ref": "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponse" }, "parameters": { "entityType": { "description": "Required. The resource name of the EntityType for the entity being read. Value format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:readFeatureValues", "parameterOrder": [ "entityType" ], "description": "Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues." }, "getIamPolicy": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:getIamPolicy", "response": { "$ref": "GoogleIamV1Policy" }, "parameters": { "options.requestedPolicyVersion": { "type": "integer", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query" }, "resource": { "type": "string", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "location": "path" } }, "parameterOrder": [ "resource" ], "path": "v1beta1/{+resource}:getIamPolicy", "httpMethod": "POST", "id": "aiplatform.projects.locations.featurestores.entityTypes.getIamPolicy", "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "exportFeatureValues": { "path": "v1beta1/{+entityType}:exportFeatureValues", "parameterOrder": [ "entityType" ], "parameters": { "entityType": { "location": "path", "description": "Required. The resource name of the EntityType from which to export Feature values. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$" } }, "httpMethod": "POST", "id": "aiplatform.projects.locations.featurestores.entityTypes.exportFeatureValues", "description": "Exports Feature values from all the entities of a target EntityType.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:exportFeatureValues", "request": { "$ref": "GoogleCloudAiplatformV1beta1ExportFeatureValuesRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "writeFeatureValues": { "parameterOrder": [ "entityType" ], "path": "v1beta1/{+entityType}:writeFeatureValues", "id": "aiplatform.projects.locations.featurestores.entityTypes.writeFeatureValues", "parameters": { "entityType": { "description": "Required. The resource name of the EntityType for the entities being written. Value format: `projects/{project}/locations/{location}/featurestores/ {featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "location": "path", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1WriteFeatureValuesRequest" }, "response": { "$ref": "GoogleCloudAiplatformV1beta1WriteFeatureValuesResponse" }, "description": "Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:writeFeatureValues" }, "deleteFeatureValues": { "parameterOrder": [ "entityType" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:deleteFeatureValues", "description": "Delete Feature values from Featurestore. The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done. If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.", "id": "aiplatform.projects.locations.featurestores.entityTypes.deleteFeatureValues", "path": "v1beta1/{+entityType}:deleteFeatureValues", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "entityType": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "description": "Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1DeleteFeatureValuesRequest" } }, "setIamPolicy": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:setIamPolicy", "httpMethod": "POST", "parameterOrder": [ "resource" ], "parameters": { "resource": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "location": "path", "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "required": true } }, "path": "v1beta1/{+resource}:setIamPolicy", "id": "aiplatform.projects.locations.featurestores.entityTypes.setIamPolicy", "response": { "$ref": "GoogleIamV1Policy" }, "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "httpMethod": "POST", "parameters": { "parent": { "location": "path", "type": "string", "description": "Required. The resource name of the Featurestore to create EntityTypes. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$" }, "entityTypeId": { "description": "Required. The ID to use for the EntityType, which will become the final component of the EntityType's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a featurestore.", "type": "string", "location": "query" } }, "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/entityTypes", "id": "aiplatform.projects.locations.featurestores.entityTypes.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes", "request": { "$ref": "GoogleCloudAiplatformV1beta1EntityType" }, "description": "Creates a new EntityType in a given Featurestore." }, "importFeatureValues": { "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+entityType}:importFeatureValues", "request": { "$ref": "GoogleCloudAiplatformV1beta1ImportFeatureValuesRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:importFeatureValues", "httpMethod": "POST", "parameterOrder": [ "entityType" ], "parameters": { "entityType": { "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string", "description": "Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.featurestores.entityTypes.importFeatureValues", "description": "Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned." }, "patch": { "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.featurestores.entityTypes.patch", "httpMethod": "PATCH", "description": "Updates the parameters of a single EntityType.", "parameters": { "name": { "description": "Immutable. Name of the EntityType. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$" }, "updateMask": { "description": "Field mask is used to specify the fields to be overwritten in the EntityType resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `monitoring_config.snapshot_analysis.disabled` * `monitoring_config.snapshot_analysis.monitoring_interval_days` * `monitoring_config.snapshot_analysis.staleness_days` * `monitoring_config.import_features_analysis.state` * `monitoring_config.import_features_analysis.anomaly_detection_baseline` * `monitoring_config.numerical_threshold_config.value` * `monitoring_config.categorical_threshold_config.value` * `offline_storage_ttl_days`", "location": "query", "format": "google-fieldmask", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}", "response": { "$ref": "GoogleCloudAiplatformV1beta1EntityType" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1EntityType" }, "path": "v1beta1/{+name}" } } } } }, "apps": { "resources": { "operations": { "methods": { "wait": { "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.apps.operations.wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameters": { "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "format": "google-duration", "location": "query" }, "name": { "location": "path", "description": "The name of the operation resource to wait on.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$" } }, "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}:wait", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "cancel": { "path": "v1beta1/{+name}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "id": "aiplatform.projects.locations.apps.operations.cancel", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to be cancelled.", "location": "path" } }, "parameterOrder": [ "name" ], "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}:cancel", "response": { "$ref": "GoogleProtobufEmpty" } }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.apps.operations.get", "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$", "description": "The name of the operation resource.", "type": "string" } }, "path": "v1beta1/{+name}", "httpMethod": "GET", "parameterOrder": [ "name" ] }, "list": { "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameters": { "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "name": { "location": "path", "required": true, "type": "string", "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$" }, "pageSize": { "description": "The standard list page size.", "location": "query", "format": "int32", "type": "integer" } }, "path": "v1beta1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.apps.operations.list", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}", "path": "v1beta1/{+name}", "parameters": { "name": { "type": "string", "description": "The name of the operation resource to be deleted.", "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$", "location": "path", "required": true } }, "id": "aiplatform.projects.locations.apps.operations.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameterOrder": [ "name" ] } } } } }, "persistentResources": { "resources": { "operations": { "methods": { "get": { "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.persistentResources.operations.get", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameters": { "name": { "description": "The name of the operation resource.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$", "type": "string", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}", "path": "v1beta1/{+name}" }, "delete": { "parameters": { "name": { "type": "string", "required": true, "description": "The name of the operation resource to be deleted.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.persistentResources.operations.delete", "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path", "description": "The name of the operation resource to wait on." }, "timeout": { "format": "google-duration", "location": "query", "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." } }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.persistentResources.operations.wait", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:wait", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait" }, "cancel": { "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.persistentResources.operations.cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "path": "v1beta1/{+name}:cancel", "parameters": { "name": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be cancelled." } }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel" }, "list": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "id": "aiplatform.projects.locations.persistentResources.operations.list", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", "required": true, "type": "string", "description": "The name of the operation's parent resource.", "location": "path" }, "returnPartialSuccess": { "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query" }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "pageSize": { "type": "integer", "description": "The standard list page size.", "format": "int32", "location": "query" } }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations", "path": "v1beta1/{+name}/operations" } } } }, "methods": { "create": { "httpMethod": "POST", "parameters": { "persistentResourceId": { "description": "Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.", "location": "query", "type": "string" }, "parent": { "required": true, "description": "Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "path": "v1beta1/{+parent}/persistentResources", "id": "aiplatform.projects.locations.persistentResources.create", "description": "Creates a PersistentResource.", "request": { "$ref": "GoogleCloudAiplatformV1beta1PersistentResource" }, "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ] }, "patch": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}", "path": "v1beta1/{+name}", "description": "Updates a PersistentResource.", "id": "aiplatform.projects.locations.persistentResources.patch", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", "type": "string", "location": "path", "description": "Immutable. Resource name of a PersistentResource." }, "updateMask": { "description": "Required. Specify the fields to be overwritten in the PersistentResource by the update method.", "format": "google-fieldmask", "type": "string", "location": "query" } }, "httpMethod": "PATCH", "request": { "$ref": "GoogleCloudAiplatformV1beta1PersistentResource" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "get": { "response": { "$ref": "GoogleCloudAiplatformV1beta1PersistentResource" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.persistentResources.get", "description": "Gets a PersistentResource.", "parameters": { "name": { "location": "path", "description": "Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET" }, "reboot": { "path": "v1beta1/{+name}:reboot", "httpMethod": "POST", "parameters": { "name": { "location": "path", "description": "Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`", "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", "type": "string", "required": true } }, "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.persistentResources.reboot", "request": { "$ref": "GoogleCloudAiplatformV1beta1RebootPersistentResourceRequest" }, "description": "Reboots a PersistentResource.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}:reboot", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "id": "aiplatform.projects.locations.persistentResources.list", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListPersistentResourcesResponse" }, "path": "v1beta1/{+parent}/persistentResources", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists PersistentResources in a Location.", "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "description": "Optional. The standard list page size.", "location": "query", "format": "int32", "type": "integer" }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project}/locations/{location}`", "required": true }, "pageToken": { "type": "string", "location": "query", "description": "Optional. The standard list page token. Typically obtained via ListPersistentResourcesResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call." } } }, "delete": { "id": "aiplatform.projects.locations.persistentResources.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "httpMethod": "DELETE", "description": "Deletes a PersistentResource.", "parameters": { "name": { "location": "path", "description": "Required. The name of the PersistentResource to be deleted. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$" } } } } }, "modelMonitors": { "methods": { "searchModelMonitoringStats": { "request": { "$ref": "GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsRequest" }, "description": "Searches Model Monitoring Stats generated within a given time window.", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsResponse" }, "path": "v1beta1/{+modelMonitor}:searchModelMonitoringStats", "parameters": { "modelMonitor": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$", "description": "Required. ModelMonitor resource name. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}:searchModelMonitoringStats", "id": "aiplatform.projects.locations.modelMonitors.searchModelMonitoringStats", "parameterOrder": [ "modelMonitor" ] }, "searchModelMonitoringAlerts": { "parameters": { "modelMonitor": { "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$", "description": "Required. ModelMonitor resource name. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`", "required": true, "location": "path", "type": "string" } }, "httpMethod": "POST", "parameterOrder": [ "modelMonitor" ], "id": "aiplatform.projects.locations.modelMonitors.searchModelMonitoringAlerts", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1SearchModelMonitoringAlertsRequest" }, "response": { "$ref": "GoogleCloudAiplatformV1beta1SearchModelMonitoringAlertsResponse" }, "path": "v1beta1/{+modelMonitor}:searchModelMonitoringAlerts", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}:searchModelMonitoringAlerts", "description": "Returns the Model Monitoring alerts." }, "delete": { "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "location": "path", "description": "Required. The name of the ModelMonitor resource to be deleted. Format: `projects/{project}/locations/{location}/modelMonitords/{model_monitor}`", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$" }, "force": { "description": "Optional. Force delete the model monitor with schedules.", "location": "query", "type": "boolean" } }, "description": "Deletes a ModelMonitor.", "id": "aiplatform.projects.locations.modelMonitors.delete" }, "patch": { "request": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitor" }, "parameters": { "name": { "description": "Immutable. Resource name of the ModelMonitor. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`.", "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$", "location": "path", "type": "string", "required": true }, "updateMask": { "description": "Required. Mask specifying which fields to update.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}", "id": "aiplatform.projects.locations.modelMonitors.patch", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Updates a ModelMonitor." }, "create": { "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.modelMonitors.create", "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitor" }, "parameters": { "modelMonitorId": { "type": "string", "description": "Optional. The ID to use for the Model Monitor, which will become the final component of the model monitor resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.", "location": "query" }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The resource name of the Location to create the ModelMonitor in. Format: `projects/{project}/locations/{location}`", "required": true } }, "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+parent}/modelMonitors", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors", "description": "Creates a ModelMonitor." }, "get": { "response": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitor" }, "description": "Gets a ModelMonitor.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$", "description": "Required. The name of the ModelMonitor resource. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`", "required": true, "type": "string", "location": "path" } }, "id": "aiplatform.projects.locations.modelMonitors.get", "path": "v1beta1/{+name}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "path": "v1beta1/{+parent}/modelMonitors", "description": "Lists ModelMonitors in a Location.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors", "parameterOrder": [ "parent" ], "id": "aiplatform.projects.locations.modelMonitors.list", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListModelMonitorsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "description": "Required. The resource name of the Location to list the ModelMonitors from. Format: `projects/{project}/locations/{location}`", "required": true }, "pageSize": { "location": "query", "description": "The standard list page size.", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "readMask": { "location": "query", "description": "Mask specifying which fields to read.", "format": "google-fieldmask", "type": "string" }, "filter": { "location": "query", "type": "string", "description": "The standard list filter. More detail in [AIP-160](https://google.aip.dev/160)." } } } }, "resources": { "operations": { "methods": { "delete": { "parameterOrder": [ "name" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$", "type": "string", "required": true } }, "id": "aiplatform.projects.locations.modelMonitors.operations.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE" }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$", "location": "path", "description": "The name of the operation's parent resource.", "type": "string", "required": true }, "pageSize": { "type": "integer", "description": "The standard list page size.", "format": "int32", "location": "query" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations", "httpMethod": "GET", "path": "v1beta1/{+name}/operations", "id": "aiplatform.projects.locations.modelMonitors.operations.list", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "cancel": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path" } }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}:cancel", "id": "aiplatform.projects.locations.modelMonitors.operations.cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:cancel" }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}:wait", "id": "aiplatform.projects.locations.modelMonitors.operations.wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "name": { "location": "path", "description": "The name of the operation resource to wait on.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$" }, "timeout": { "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "format": "google-duration" } } }, "get": { "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.modelMonitors.operations.get", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}", "parameters": { "name": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$", "description": "The name of the operation resource." } }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET" } } }, "modelMonitoringJobs": { "methods": { "create": { "path": "v1beta1/{+parent}/modelMonitoringJobs", "id": "aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.create", "response": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringJob" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a ModelMonitoringJob.", "request": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringJob" }, "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMoniitors/{model_monitor}`", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$" }, "modelMonitoringJobId": { "description": "Optional. The ID to use for the Model Monitoring Job, which will become the final component of the model monitoring job resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.", "type": "string", "location": "query" } }, "httpMethod": "POST" }, "get": { "httpMethod": "GET", "parameters": { "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/modelMonitoringJobs/[^/]+$", "type": "string", "description": "Required. The resource name of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}`" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringJob" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs/{modelMonitoringJobsId}", "description": "Gets a ModelMonitoringJob.", "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "list": { "id": "aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.list", "description": "Lists ModelMonitoringJobs. Callers may choose to read across multiple Monitors as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of modelMonitor id in the parent. Format `projects/{project_id}/locations/{location}/moodelMonitors/-/modelMonitoringJobs`", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+parent}/modelMonitoringJobs", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1ListModelMonitoringJobsResponse" }, "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs", "parameters": { "filter": { "type": "string", "location": "query", "description": "The standard list filter. More detail in [AIP-160](https://google.aip.dev/160)." }, "readMask": { "type": "string", "location": "query", "description": "Mask specifying which fields to read", "format": "google-fieldmask" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "parent": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$", "location": "path", "description": "Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`" }, "pageSize": { "description": "The standard list page size.", "type": "integer", "format": "int32", "location": "query" } } }, "delete": { "description": "Deletes a ModelMonitoringJob.", "parameters": { "name": { "required": true, "description": "Required. The resource name of the model monitoring job to delete. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/modelMonitoringJobs/[^/]+$", "location": "path" } }, "id": "aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.delete", "httpMethod": "DELETE", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs/{modelMonitoringJobsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } }, "specialistPools": { "methods": { "list": { "parameters": { "pageSize": { "type": "integer", "description": "The standard list page size.", "format": "int32", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "description": "Required. The name of the SpecialistPool's parent resource. Format: `projects/{project}/locations/{location}`", "location": "path" }, "readMask": { "location": "query", "format": "google-fieldmask", "description": "Mask specifying which fields to read. FieldMask represents a set of", "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty." } }, "httpMethod": "GET", "id": "aiplatform.projects.locations.specialistPools.list", "description": "Lists SpecialistPools in a Location.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/specialistPools", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListSpecialistPoolsResponse" } }, "patch": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "updateMask": { "location": "query", "description": "Required. The update mask applies to the resource.", "format": "google-fieldmask", "type": "string" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", "location": "path", "description": "Required. The resource name of the SpecialistPool.", "type": "string", "required": true } }, "id": "aiplatform.projects.locations.specialistPools.patch", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "PATCH", "request": { "$ref": "GoogleCloudAiplatformV1beta1SpecialistPool" }, "description": "Updates a SpecialistPool.", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ] }, "delete": { "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "force": { "description": "If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.)", "location": "query", "type": "boolean" }, "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", "type": "string", "description": "Required. The resource name of the SpecialistPool to delete. Format: `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`", "location": "path" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", "path": "v1beta1/{+name}", "description": "Deletes a SpecialistPool as well as all Specialists in the pool.", "id": "aiplatform.projects.locations.specialistPools.delete" }, "get": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", "parameters": { "name": { "location": "path", "type": "string", "description": "Required. The name of the SpecialistPool resource. The form is `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$" } }, "httpMethod": "GET", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleCloudAiplatformV1beta1SpecialistPool" }, "id": "aiplatform.projects.locations.specialistPools.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets a SpecialistPool.", "parameterOrder": [ "name" ] }, "create": { "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "location": "path", "description": "Required. The parent Project name for the new SpecialistPool. The form is `projects/{project}/locations/{location}`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools", "id": "aiplatform.projects.locations.specialistPools.create", "path": "v1beta1/{+parent}/specialistPools", "parameterOrder": [ "parent" ], "description": "Creates a SpecialistPool.", "request": { "$ref": "GoogleCloudAiplatformV1beta1SpecialistPool" } } }, "resources": { "operations": { "methods": { "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource to be deleted.", "location": "path" } }, "id": "aiplatform.projects.locations.specialistPools.operations.delete", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "wait": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.specialistPools.operations.wait", "path": "v1beta1/{+name}:wait", "parameters": { "timeout": { "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "location": "query" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to wait on.", "location": "path", "type": "string", "required": true } }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "httpMethod": "POST" }, "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.specialistPools.operations.list", "path": "v1beta1/{+name}/operations", "parameters": { "returnPartialSuccess": { "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query" }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", "description": "The name of the operation's parent resource.", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "location": "query", "format": "int32", "description": "The standard list page size.", "type": "integer" }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" } }, "httpMethod": "GET" }, "get": { "httpMethod": "GET", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "required": true } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.specialistPools.operations.get" }, "cancel": { "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel", "path": "v1beta1/{+name}:cancel", "parameters": { "name": { "location": "path", "type": "string", "required": true, "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$" } }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "id": "aiplatform.projects.locations.specialistPools.operations.cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST" } } } } }, "indexes": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "httpMethod": "GET", "id": "aiplatform.projects.locations.indexes.get", "parameters": { "name": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", "description": "Required. The name of the Index resource. Format: `projects/{project}/locations/{location}/indexes/{index}`", "required": true } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1Index" }, "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", "description": "Gets an Index." }, "delete": { "httpMethod": "DELETE", "path": "v1beta1/{+name}", "description": "Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed.", "parameters": { "name": { "location": "path", "required": true, "type": "string", "description": "Required. The name of the Index resource to be deleted. Format: `projects/{project}/locations/{location}/indexes/{index}`", "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$" } }, "id": "aiplatform.projects.locations.indexes.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", "response": { "$ref": "GoogleLongrunningOperation" } }, "removeDatapoints": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints", "description": "Remove Datapoints from an Index.", "request": { "$ref": "GoogleCloudAiplatformV1beta1RemoveDatapointsRequest" }, "id": "aiplatform.projects.locations.indexes.removeDatapoints", "response": { "$ref": "GoogleCloudAiplatformV1beta1RemoveDatapointsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "index" ], "parameters": { "index": { "required": true, "description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`", "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", "location": "path", "type": "string" } }, "httpMethod": "POST", "path": "v1beta1/{+index}:removeDatapoints" }, "upsertDatapoints": { "request": { "$ref": "GoogleCloudAiplatformV1beta1UpsertDatapointsRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1UpsertDatapointsResponse" }, "parameterOrder": [ "index" ], "path": "v1beta1/{+index}:upsertDatapoints", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints", "id": "aiplatform.projects.locations.indexes.upsertDatapoints", "description": "Add/update Datapoints into an Index.", "httpMethod": "POST", "parameters": { "index": { "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", "required": true, "description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`", "type": "string", "location": "path" } } }, "patch": { "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "parameters": { "name": { "location": "path", "type": "string", "required": true, "description": "Output only. The resource name of the Index.", "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$" }, "updateMask": { "type": "string", "location": "query", "format": "google-fieldmask", "description": "The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask." } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1Index" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "description": "Updates an Index.", "id": "aiplatform.projects.locations.indexes.patch" }, "list": { "id": "aiplatform.projects.locations.indexes.list", "description": "Lists Indexes in a Location.", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListIndexesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "httpMethod": "GET", "path": "v1beta1/{+parent}/indexes", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes", "parameters": { "parent": { "description": "Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "The standard list page size." }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "readMask": { "description": "Mask specifying which fields to read.", "format": "google-fieldmask", "type": "string", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call." } } }, "create": { "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "required": true, "description": "Required. The resource name of the Location to create the Index in. Format: `projects/{project}/locations/{location}`", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.indexes.create", "request": { "$ref": "GoogleCloudAiplatformV1beta1Index" }, "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/indexes", "description": "Creates an Index." }, "import": { "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1ImportIndexRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}:import", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:import", "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", "type": "string", "description": "Required. The name of the Index resource to import data to. Format: `projects/{project}/locations/{location}/indexes/{index}`" } }, "httpMethod": "POST", "id": "aiplatform.projects.locations.indexes.import", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Imports an Index from an external source (e.g., BigQuery)." } }, "resources": { "operations": { "methods": { "list": { "parameterOrder": [ "name" ], "path": "v1beta1/{+name}/operations", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", "required": true, "description": "The name of the operation's parent resource.", "type": "string", "location": "path" }, "pageSize": { "description": "The standard list page size.", "format": "int32", "type": "integer", "location": "query" }, "returnPartialSuccess": { "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query" }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." } }, "id": "aiplatform.projects.locations.indexes.operations.list", "httpMethod": "GET" }, "cancel": { "httpMethod": "POST", "parameters": { "name": { "required": true, "location": "path", "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.projects.locations.indexes.operations.cancel", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel" }, "wait": { "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.indexes.operations.wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:wait", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", "type": "string", "required": true, "description": "The name of the operation resource to wait on.", "location": "path" }, "timeout": { "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:wait", "parameterOrder": [ "name" ] }, "get": { "id": "aiplatform.projects.locations.indexes.operations.get", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}", "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", "type": "string", "location": "path", "required": true, "description": "The name of the operation resource." } }, "httpMethod": "GET", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation resource to be deleted.", "required": true } }, "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}", "id": "aiplatform.projects.locations.indexes.operations.delete", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" } } } } } }, "cachedContents": { "methods": { "create": { "description": "Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.", "parameters": { "parent": { "required": true, "type": "string", "description": "Required. The parent resource where the cached content will be created", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents", "httpMethod": "POST", "response": { "$ref": "GoogleCloudAiplatformV1beta1CachedContent" }, "path": "v1beta1/{+parent}/cachedContents", "id": "aiplatform.projects.locations.cachedContents.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1CachedContent" }, "parameterOrder": [ "parent" ] }, "get": { "parameters": { "name": { "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$", "description": "Required. The resource name referring to the cached content" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1CachedContent" }, "path": "v1beta1/{+name}", "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}", "parameterOrder": [ "name" ], "description": "Gets cached content configurations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.cachedContents.get" }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1CachedContent" }, "description": "Updates cached content configurations", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}", "parameters": { "updateMask": { "location": "query", "description": "Required. The list of fields to update.", "format": "google-fieldmask", "type": "string" }, "name": { "required": true, "description": "Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}", "pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "httpMethod": "PATCH", "id": "aiplatform.projects.locations.cachedContents.patch", "response": { "$ref": "GoogleCloudAiplatformV1beta1CachedContent" } }, "delete": { "description": "Deletes cached content", "httpMethod": "DELETE", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}", "path": "v1beta1/{+name}", "parameters": { "name": { "location": "path", "description": "Required. The resource name referring to the cached content", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.cachedContents.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ] }, "list": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListCachedContentsResponse" }, "path": "v1beta1/{+parent}/cachedContents", "description": "Lists cached contents in a project", "parameters": { "pageToken": { "type": "string", "description": "Optional. A page token, received from a previous `ListCachedContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCachedContents` must match the call that provided the page token.", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "type": "string", "description": "Required. The parent, which owns this collection of cached contents.", "required": true }, "pageSize": { "location": "query", "type": "integer", "description": "Optional. The maximum number of cached contents to return. The service may return fewer than this value. If unspecified, some default (under maximum) number of items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32" } }, "parameterOrder": [ "parent" ], "httpMethod": "GET", "id": "aiplatform.projects.locations.cachedContents.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "evaluationRuns": { "methods": { "create": { "path": "v1beta1/{+parent}/evaluationRuns", "description": "Creates an Evaluation Run.", "request": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationRun" }, "httpMethod": "POST", "id": "aiplatform.projects.locations.evaluationRuns.create", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns", "parameters": { "parent": { "required": true, "description": "Required. The resource name of the Location to create the Evaluation Run in. Format: `projects/{project}/locations/{location}`", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationRun" } }, "cancel": { "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Cancels an Evaluation Run. Attempts to cancel a running Evaluation Run asynchronously. Status of run can be checked via GetEvaluationRun.", "path": "v1beta1/{+name}:cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}:cancel", "request": { "$ref": "GoogleCloudAiplatformV1beta1CancelEvaluationRunRequest" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", "required": true, "type": "string", "description": "Required. The name of the EvaluationRun resource to be cancelled. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", "location": "path" } }, "parameterOrder": [ "name" ], "httpMethod": "POST", "id": "aiplatform.projects.locations.evaluationRuns.cancel" }, "get": { "description": "Gets an Evaluation Run.", "id": "aiplatform.projects.locations.evaluationRuns.get", "response": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationRun" }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", "description": "Required. The name of the EvaluationRun resource. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", "location": "path", "type": "string" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}" }, "delete": { "id": "aiplatform.projects.locations.evaluationRuns.delete", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "description": "Required. The name of the EvaluationRun resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "httpMethod": "DELETE", "description": "Deletes an Evaluation Run.", "path": "v1beta1/{+name}" }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.evaluationRuns.list", "parameters": { "filter": { "location": "query", "type": "string", "description": "Optional. Filter expression that matches a subset of the EvaluationRuns to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160)." }, "pageToken": { "type": "string", "description": "Optional. A page token, received from a previous `ListEvaluationRuns` call. Provide this to retrieve the subsequent page.", "location": "query" }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "Optional. The maximum number of Evaluation Runs to return." }, "orderBy": { "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", "location": "query", "type": "string" }, "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path", "description": "Required. The resource name of the Location from which to list the Evaluation Runs. Format: `projects/{project}/locations/{location}`" } }, "description": "Lists Evaluation Runs.", "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns", "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/evaluationRuns", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListEvaluationRunsResponse" } } }, "resources": { "operations": { "methods": { "delete": { "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "httpMethod": "DELETE", "parameters": { "name": { "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted." } }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.evaluationRuns.operations.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}/operations/{operationsId}" }, "wait": { "id": "aiplatform.projects.locations.evaluationRuns.operations.wait", "parameterOrder": [ "name" ], "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}/operations/{operationsId}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to wait on.", "required": true, "type": "string", "location": "path" }, "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "format": "google-duration", "type": "string" } }, "path": "v1beta1/{+name}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" } }, "get": { "parameterOrder": [ "name" ], "httpMethod": "GET", "id": "aiplatform.projects.locations.evaluationRuns.operations.get", "parameters": { "name": { "location": "path", "description": "The name of the operation resource.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+/operations/[^/]+$" } }, "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", "required": true, "description": "The name of the operation's parent resource.", "location": "path", "type": "string" }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "The standard list page size." }, "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" } }, "path": "v1beta1/{+name}/operations", "id": "aiplatform.projects.locations.evaluationRuns.operations.list", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}/operations" } } } } }, "studies": { "resources": { "operations": { "methods": { "wait": { "httpMethod": "POST", "parameters": { "name": { "location": "path", "description": "The name of the operation resource to wait on.", "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, "timeout": { "type": "string", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration" } }, "id": "aiplatform.projects.locations.studies.operations.wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:wait", "parameterOrder": [ "name" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" } }, "list": { "id": "aiplatform.projects.locations.studies.operations.list", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "httpMethod": "GET", "parameters": { "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "name": { "required": true, "type": "string", "description": "The name of the operation's parent resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$" }, "pageSize": { "format": "int32", "type": "integer", "description": "The standard list page size.", "location": "query" }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" } }, "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations" }, "cancel": { "id": "aiplatform.projects.locations.studies.operations.cancel", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}:cancel", "parameterOrder": [ "name" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." }, "delete": { "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}", "path": "v1beta1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation resource to be deleted.", "required": true } }, "id": "aiplatform.projects.locations.studies.operations.delete", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "name": { "location": "path", "description": "The name of the operation resource.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}", "id": "aiplatform.projects.locations.studies.operations.get", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}" } } }, "trials": { "methods": { "addTrialMeasurement": { "response": { "$ref": "GoogleCloudAiplatformV1beta1Trial" }, "id": "aiplatform.projects.locations.studies.trials.addTrialMeasurement", "parameterOrder": [ "trialName" ], "description": "Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.", "parameters": { "trialName": { "location": "path", "type": "string", "description": "Required. The name of the trial to add measurement. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1AddTrialMeasurementRequest" }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+trialName}:addTrialMeasurement" }, "stop": { "response": { "$ref": "GoogleCloudAiplatformV1beta1Trial" }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop", "path": "v1beta1/{+name}:stop", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", "type": "string", "required": true, "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Stops a Trial.", "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1StopTrialRequest" }, "id": "aiplatform.projects.locations.studies.trials.stop" }, "complete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.studies.trials.complete", "parameterOrder": [ "name" ], "description": "Marks a Trial as complete.", "path": "v1beta1/{+name}:complete", "parameters": { "name": { "location": "path", "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1CompleteTrialRequest" }, "httpMethod": "POST", "response": { "$ref": "GoogleCloudAiplatformV1beta1Trial" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete" }, "suggest": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1SuggestTrialsRequest" }, "parameterOrder": [ "parent" ], "description": "Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse.", "id": "aiplatform.projects.locations.studies.trials.suggest", "path": "v1beta1/{+parent}/trials:suggest", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "location": "path", "description": "Required. The project and location that the Study belongs to. Format: `projects/{project}/locations/{location}/studies/{study}`", "type": "string", "required": true } }, "httpMethod": "POST" }, "list": { "parameters": { "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "Optional. The number of Trials to retrieve per \"page\" of results. If unspecified, the service will pick an appropriate default." }, "parent": { "description": "Required. The resource name of the Study to list the Trial from. Format: `projects/{project}/locations/{location}/studies/{study}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "location": "path", "required": true }, "pageToken": { "description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.", "location": "query", "type": "string" } }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.studies.trials.list", "description": "Lists the Trials associated with a Study.", "path": "v1beta1/{+parent}/trials", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListTrialsResponse" } }, "listOptimalTrials": { "request": { "$ref": "GoogleCloudAiplatformV1beta1ListOptimalTrialsRequest" }, "description": "Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency", "path": "v1beta1/{+parent}/trials:listOptimalTrials", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1ListOptimalTrialsResponse" }, "id": "aiplatform.projects.locations.studies.trials.listOptimalTrials", "parameterOrder": [ "parent" ], "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials", "parameters": { "parent": { "description": "Required. The name of the Study that the optimal Trial belongs to.", "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "location": "path", "type": "string", "required": true } } }, "get": { "httpMethod": "GET", "parameters": { "name": { "type": "string", "location": "path", "description": "Required. The name of the Trial resource. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", "required": true } }, "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1Trial" }, "description": "Gets a Trial.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}", "id": "aiplatform.projects.locations.studies.trials.get", "parameterOrder": [ "name" ] }, "create": { "description": "Adds a user provided Trial to a Study.", "path": "v1beta1/{+parent}/trials", "response": { "$ref": "GoogleCloudAiplatformV1beta1Trial" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1Trial" }, "id": "aiplatform.projects.locations.studies.trials.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "description": "Required. The resource name of the Study to create the Trial in. Format: `projects/{project}/locations/{location}/studies/{study}`", "required": true, "location": "path" } }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials", "parameterOrder": [ "parent" ] }, "delete": { "description": "Deletes a Trial.", "id": "aiplatform.projects.locations.studies.trials.delete", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "parameters": { "name": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", "required": true } } }, "checkTrialEarlyStoppingState": { "path": "v1beta1/{+trialName}:checkTrialEarlyStoppingState", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState", "httpMethod": "POST", "parameters": { "trialName": { "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`" } }, "id": "aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState", "parameterOrder": [ "trialName" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.", "request": { "$ref": "GoogleCloudAiplatformV1beta1CheckTrialEarlyStoppingStateRequest" } } }, "resources": { "operations": { "methods": { "delete": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation resource to be deleted.", "required": true } }, "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.studies.trials.operations.delete", "path": "v1beta1/{+name}" }, "get": { "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "type": "string", "location": "path", "required": true, "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", "id": "aiplatform.projects.locations.studies.trials.operations.get", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "wait": { "id": "aiplatform.projects.locations.studies.trials.operations.wait", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "path": "v1beta1/{+name}:wait", "parameters": { "name": { "location": "path", "description": "The name of the operation resource to wait on.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$" }, "timeout": { "type": "string", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST" }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v1beta1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "The standard list page size." }, "name": { "location": "path", "type": "string", "description": "The name of the operation's parent resource.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations", "httpMethod": "GET", "id": "aiplatform.projects.locations.studies.trials.operations.list", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameterOrder": [ "name" ] }, "cancel": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel", "path": "v1beta1/{+name}:cancel", "httpMethod": "POST", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be cancelled.", "type": "string", "required": true, "location": "path" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.projects.locations.studies.trials.operations.cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameterOrder": [ "name" ] } } } } } }, "methods": { "delete": { "httpMethod": "DELETE", "id": "aiplatform.projects.locations.studies.delete", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "location": "path", "type": "string", "description": "Required. The name of the Study resource to be deleted. Format: `projects/{project}/locations/{location}/studies/{study}`", "required": true } }, "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}", "parameterOrder": [ "name" ], "description": "Deletes a Study.", "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "request": { "$ref": "GoogleCloudAiplatformV1beta1Study" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies", "response": { "$ref": "GoogleCloudAiplatformV1beta1Study" }, "path": "v1beta1/{+parent}/studies", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "type": "string", "required": true } }, "id": "aiplatform.projects.locations.studies.create", "description": "Creates a Study. A resource name will be generated after creation of the Study.", "httpMethod": "POST" }, "get": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1Study" }, "id": "aiplatform.projects.locations.studies.get", "description": "Gets a Study by name.", "path": "v1beta1/{+name}", "httpMethod": "GET", "parameters": { "name": { "type": "string", "description": "Required. The name of the Study resource. Format: `projects/{project}/locations/{location}/studies/{study}`", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$" } } }, "lookup": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies:lookup", "response": { "$ref": "GoogleCloudAiplatformV1beta1Study" }, "parameters": { "parent": { "description": "Required. The resource name of the Location to get the Study from. Format: `projects/{project}/locations/{location}`", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "id": "aiplatform.projects.locations.studies.lookup", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameterOrder": [ "parent" ], "description": "Looks a study up using the user-defined display_name field instead of the fully qualified resource name.", "request": { "$ref": "GoogleCloudAiplatformV1beta1LookupStudyRequest" }, "path": "v1beta1/{+parent}/studies:lookup" }, "list": { "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "description": "Optional. The maximum number of studies to return per \"page\" of results. If unspecified, service will pick an appropriate default.", "type": "integer", "format": "int32", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The resource name of the Location to list the Study from. Format: `projects/{project}/locations/{location}`", "required": true, "location": "path", "type": "string" } }, "path": "v1beta1/{+parent}/studies", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies", "httpMethod": "GET", "id": "aiplatform.projects.locations.studies.list", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListStudiesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists all the studies in a region for an associated project." } } }, "featureOnlineStores": { "methods": { "list": { "path": "v1beta1/{+parent}/featureOnlineStores", "id": "aiplatform.projects.locations.featureOnlineStores.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists FeatureOnlineStores in a given project and location.", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListFeatureOnlineStoresResponse" }, "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores", "parameterOrder": [ "parent" ], "parameters": { "parent": { "required": true, "type": "string", "description": "Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageSize": { "format": "int32", "description": "The maximum number of FeatureOnlineStores to return. The service may return fewer than this value. If unspecified, at most 100 FeatureOnlineStores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", "type": "integer", "location": "query" }, "orderBy": { "location": "query", "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`", "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureOnlineStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureOnlineStores must match the call that provided the page token." }, "filter": { "location": "query", "description": "Lists the FeatureOnlineStores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, and `\u003e=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003c=`, and `\u003e=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \u003e \"2020-01-01\" OR update_time \u003e \"2020-01-01\"` FeatureOnlineStores created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureOnlineStores with label \"env\" set to \"prod\".", "type": "string" } } }, "delete": { "id": "aiplatform.projects.locations.featureOnlineStores.delete", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", "path": "v1beta1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", "description": "Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", "required": true, "type": "string", "location": "path" }, "force": { "type": "boolean", "location": "query", "description": "If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.)" } }, "parameterOrder": [ "name" ], "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStore" }, "id": "aiplatform.projects.locations.featureOnlineStores.patch", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", "path": "v1beta1/{+name}", "description": "Updates the parameters of a single FeatureOnlineStore.", "parameterOrder": [ "name" ], "parameters": { "updateMask": { "description": "Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica`", "type": "string", "format": "google-fieldmask", "location": "query" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", "required": true, "description": "Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`", "location": "path", "type": "string" } }, "httpMethod": "PATCH" }, "testIamPermissions": { "id": "aiplatform.projects.locations.featureOnlineStores.testIamPermissions", "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:testIamPermissions", "parameterOrder": [ "resource" ], "parameters": { "permissions": { "repeated": true, "type": "string", "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", "location": "query" }, "resource": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", "type": "string", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+resource}:testIamPermissions", "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" } }, "getIamPolicy": { "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+resource}:getIamPolicy", "httpMethod": "POST", "response": { "$ref": "GoogleIamV1Policy" }, "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "parameters": { "resource": { "required": true, "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$" }, "options.requestedPolicyVersion": { "type": "integer", "location": "query", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32" } }, "id": "aiplatform.projects.locations.featureOnlineStores.getIamPolicy", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:getIamPolicy" }, "get": { "description": "Gets details of a single FeatureOnlineStore.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", "id": "aiplatform.projects.locations.featureOnlineStores.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "required": true, "description": "Required. The name of the FeatureOnlineStore resource.", "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", "location": "path" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStore" }, "httpMethod": "GET", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ] }, "setIamPolicy": { "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:setIamPolicy", "parameterOrder": [ "resource" ], "parameters": { "resource": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", "type": "string", "required": true, "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." } }, "response": { "$ref": "GoogleIamV1Policy" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.featureOnlineStores.setIamPolicy", "path": "v1beta1/{+resource}:setIamPolicy", "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors." }, "create": { "id": "aiplatform.projects.locations.featureOnlineStores.create", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+parent}/featureOnlineStores", "httpMethod": "POST", "description": "Creates a new FeatureOnlineStore in a given project and location.", "parameters": { "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}`", "type": "string", "location": "path" }, "featureOnlineStoreId": { "type": "string", "description": "Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.", "location": "query" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStore" }, "response": { "$ref": "GoogleLongrunningOperation" } } }, "resources": { "featureViews": { "resources": { "featureViewSyncs": { "methods": { "get": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs/{featureViewSyncsId}", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1FeatureViewSync" }, "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single FeatureViewSync.", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/featureViewSyncs/[^/]+$", "location": "path", "type": "string", "description": "Required. The name of the FeatureViewSync resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`", "required": true } } }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+parent}/featureViewSyncs", "httpMethod": "GET", "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list", "parameters": { "orderBy": { "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time`", "location": "query", "type": "string" }, "parent": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "description": "Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", "location": "path" }, "pageToken": { "type": "string", "description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViewSyncs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViewSyncs must match the call that provided the page token.", "location": "query" }, "filter": { "location": "query", "description": "Lists the FeatureViewSyncs that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003e=`, and `\u003c=` comparisons. Values must be in RFC 3339 format. Examples: * `create_time \u003e \\\"2020-01-31T15:30:00.000000Z\\\"` --\u003e FeatureViewSyncs created after 2020-01-31T15:30:00.000000Z.", "type": "string" }, "pageSize": { "type": "integer", "description": "The maximum number of FeatureViewSyncs to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", "location": "query", "format": "int32" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1ListFeatureViewSyncsResponse" }, "parameterOrder": [ "parent" ], "description": "Lists FeatureViewSyncs in a given FeatureView.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs" } } }, "operations": { "methods": { "get": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.get", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource.", "location": "path" } } }, "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1beta1/{+name}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "location": "path", "required": true }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "pageSize": { "location": "query", "type": "integer", "description": "The standard list page size.", "format": "int32" }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." } }, "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.list", "parameterOrder": [ "name" ] }, "wait": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to wait on.", "required": true, "type": "string" }, "timeout": { "format": "google-duration", "type": "string", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." } }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait", "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait", "parameterOrder": [ "name" ] }, "delete": { "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to be deleted." } }, "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.delete", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "path": "v1beta1/{+name}" } } } }, "methods": { "patch": { "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.patch", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", "parameters": { "updateMask": { "type": "string", "location": "query", "description": "Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` * `optimized_config.automatic_resources`", "format": "google-fieldmask" }, "name": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "description": "Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1FeatureView" }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Updates the parameters of a single FeatureView." }, "setIamPolicy": { "path": "v1beta1/{+resource}:setIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ], "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.setIamPolicy", "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:setIamPolicy", "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "type": "string", "required": true, "location": "path", "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." } }, "response": { "$ref": "GoogleIamV1Policy" }, "httpMethod": "POST" }, "fetchFeatureValues": { "parameterOrder": [ "featureView" ], "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues", "path": "v1beta1/{+featureView}:fetchFeatureValues", "description": "Fetch feature values under a FeatureView.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "featureView": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponse" }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1FetchFeatureValuesRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:fetchFeatureValues" }, "create": { "parameterOrder": [ "parent" ], "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", "type": "string", "location": "path", "description": "Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", "required": true }, "featureViewId": { "location": "query", "description": "Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a FeatureOnlineStore.", "type": "string" }, "runSyncImmediately": { "type": "boolean", "description": "Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not.", "location": "query" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1FeatureView" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.create", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Creates a new FeatureView in a given FeatureOnlineStore.", "path": "v1beta1/{+parent}/featureViews" }, "sync": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.sync", "parameters": { "featureView": { "description": "Required. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "required": true, "type": "string" } }, "parameterOrder": [ "featureView" ], "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1SyncFeatureViewRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync", "description": "Triggers on-demand sync for the FeatureView.", "response": { "$ref": "GoogleCloudAiplatformV1beta1SyncFeatureViewResponse" }, "path": "v1beta1/{+featureView}:sync" }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "description": "Required. The name of the FeatureView resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`" } }, "httpMethod": "GET", "path": "v1beta1/{+name}", "description": "Gets details of a single FeatureView.", "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.get", "response": { "$ref": "GoogleCloudAiplatformV1beta1FeatureView" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}" }, "list": { "httpMethod": "GET", "parameters": { "filter": { "description": "Lists the FeatureViews that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003e=`, and `\u003c=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `\u003c`, `\u003e`, `\u003e=`, and `\u003c=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time \u003e \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time \u003e \\\"2020-01-31T15:30:00.000000Z\\\"` --\u003e FeatureViews created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\u003e FeatureViews having both (active: yes) and (env: prod) labels. * `labels.env: *` --\u003e Any FeatureView which has a label with 'env' as the key.", "type": "string", "location": "query" }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "The maximum number of FeatureViews to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViews will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000." }, "parent": { "location": "path", "description": "Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$" }, "pageToken": { "type": "string", "description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViews must match the call that provided the page token.", "location": "query" }, "orderBy": { "location": "query", "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_view_id` * `create_time` * `update_time`", "type": "string" } }, "description": "Lists FeatureViews in a given FeatureOnlineStore.", "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.list", "parameterOrder": [ "parent" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+parent}/featureViews", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListFeatureViewsResponse" } }, "testIamPermissions": { "path": "v1beta1/{+resource}:testIamPermissions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:testIamPermissions", "parameterOrder": [ "resource" ], "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.testIamPermissions", "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "required": true, "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "location": "path" }, "permissions": { "location": "query", "type": "string", "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", "repeated": true } }, "httpMethod": "POST" }, "searchNearestEntities": { "httpMethod": "POST", "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities", "parameters": { "featureView": { "location": "path", "description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "type": "string" } }, "description": "Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.", "response": { "$ref": "GoogleCloudAiplatformV1beta1SearchNearestEntitiesResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:searchNearestEntities", "parameterOrder": [ "featureView" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1SearchNearestEntitiesRequest" }, "path": "v1beta1/{+featureView}:searchNearestEntities" }, "directWrite": { "parameterOrder": [ "featureView" ], "path": "v1beta1/{+featureView}:directWrite", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "featureView": { "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "location": "path", "description": "FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", "type": "string", "required": true } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:directWrite", "description": "Bidirectional streaming RPC to directly write to feature values in a feature view. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency.", "httpMethod": "POST", "response": { "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteResponse" }, "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.directWrite", "request": { "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequest" } }, "delete": { "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single FeatureView.", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the FeatureView to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "required": true, "type": "string", "location": "path" } } }, "generateFetchAccessToken": { "parameters": { "featureView": { "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "required": true, "description": "FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", "location": "path", "type": "string" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1GenerateFetchAccessTokenRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:generateFetchAccessToken", "httpMethod": "POST", "response": { "$ref": "GoogleCloudAiplatformV1beta1GenerateFetchAccessTokenResponse" }, "parameterOrder": [ "featureView" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.generateFetchAccessToken", "path": "v1beta1/{+featureView}:generateFetchAccessToken", "description": "RPC to generate an access token for the given feature view. FeatureViews under the same FeatureOnlineStore share the same access token." }, "streamingFetchFeatureValues": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Bidirectional streaming RPC to fetch feature values under a FeatureView. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency.", "request": { "$ref": "GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesRequest" }, "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.streamingFetchFeatureValues", "parameterOrder": [ "featureView" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesResponse" }, "path": "v1beta1/{+featureView}:streamingFetchFeatureValues", "parameters": { "featureView": { "type": "string", "location": "path", "description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "required": true } }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:streamingFetchFeatureValues" }, "getIamPolicy": { "parameters": { "options.requestedPolicyVersion": { "format": "int32", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "location": "query", "type": "integer" }, "resource": { "location": "path", "type": "string", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$" } }, "httpMethod": "POST", "path": "v1beta1/{+resource}:getIamPolicy", "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.getIamPolicy", "response": { "$ref": "GoogleIamV1Policy" }, "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:getIamPolicy" } } }, "operations": { "methods": { "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.featureOnlineStores.operations.list", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1beta1/{+name}/operations", "parameters": { "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "The standard list page size." }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", "type": "string", "required": true, "description": "The name of the operation's parent resource.", "location": "path" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" } }, "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations" }, "delete": { "parameters": { "name": { "type": "string", "description": "The name of the operation resource to be deleted.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$" } }, "parameterOrder": [ "name" ], "httpMethod": "DELETE", "id": "aiplatform.projects.locations.featureOnlineStores.operations.delete", "path": "v1beta1/{+name}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "id": "aiplatform.projects.locations.featureOnlineStores.operations.get", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameters": { "name": { "required": true, "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$", "location": "path", "type": "string" } }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "httpMethod": "GET", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "wait": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait", "id": "aiplatform.projects.locations.featureOnlineStores.operations.wait", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:wait", "parameters": { "name": { "type": "string", "description": "The name of the operation resource to wait on.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$" }, "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "type": "string", "format": "google-duration" } }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "httpMethod": "POST" } } } } }, "edgeDevices": { "resources": { "operations": { "methods": { "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "httpMethod": "DELETE", "id": "aiplatform.projects.locations.edgeDevices.operations.delete", "path": "v1beta1/{+name}", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$", "type": "string", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}", "parameterOrder": [ "name" ] }, "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "id": "aiplatform.projects.locations.edgeDevices.operations.cancel", "path": "v1beta1/{+name}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$", "location": "path" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ] }, "list": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "id": "aiplatform.projects.locations.edgeDevices.operations.list", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations", "path": "v1beta1/{+name}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameters": { "pageSize": { "description": "The standard list page size.", "location": "query", "format": "int32", "type": "integer" }, "name": { "location": "path", "type": "string", "description": "The name of the operation's parent resource.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+$" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." } }, "httpMethod": "GET" }, "get": { "id": "aiplatform.projects.locations.edgeDevices.operations.get", "httpMethod": "GET", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "path": "v1beta1/{+name}", "parameters": { "name": { "description": "The name of the operation resource.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "wait": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.edgeDevices.operations.wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}:wait", "parameters": { "name": { "required": true, "description": "The name of the operation resource to wait on.", "pattern": "^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$", "location": "path", "type": "string" }, "timeout": { "format": "google-duration", "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}:wait", "httpMethod": "POST" } } } } }, "hyperparameterTuningJobs": { "resources": { "operations": { "methods": { "delete": { "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "description": "The name of the operation resource to be deleted.", "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", "location": "path", "type": "string" } }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}", "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "path": "v1beta1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.list", "parameters": { "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$", "location": "path", "type": "string", "required": true }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "pageSize": { "description": "The standard list page size.", "format": "int32", "type": "integer", "location": "query" }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" } }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "httpMethod": "GET", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations" }, "get": { "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path" } }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}", "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.get", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "wait": { "path": "v1beta1/{+name}:wait", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameters": { "timeout": { "format": "google-duration", "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query" }, "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to wait on.", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait" }, "cancel": { "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.cancel", "parameters": { "name": { "location": "path", "description": "The name of the operation resource to be cancelled.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "path": "v1beta1/{+name}:cancel" } } } }, "methods": { "get": { "httpMethod": "GET", "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`", "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1HyperparameterTuningJob" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}", "description": "Gets a HyperparameterTuningJob", "id": "aiplatform.projects.locations.hyperparameterTuningJobs.get", "path": "v1beta1/{+name}" }, "delete": { "path": "v1beta1/{+name}", "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$" } }, "httpMethod": "DELETE", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a HyperparameterTuningJob.", "id": "aiplatform.projects.locations.hyperparameterTuningJobs.delete" }, "list": { "id": "aiplatform.projects.locations.hyperparameterTuningJobs.list", "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/hyperparameterTuningJobs", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListHyperparameterTuningJobsResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists HyperparameterTuningJobs in a Location.", "httpMethod": "GET", "parameters": { "pageSize": { "format": "int32", "description": "The standard list page size.", "location": "query", "type": "integer" }, "filter": { "location": "query", "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`\u003c`, `\u003c=`,`\u003e`, `\u003e=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time\u003e\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", "type": "string" }, "readMask": { "location": "query", "description": "Mask specifying which fields to read.", "type": "string", "format": "google-fieldmask" }, "parent": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project}/locations/{location}`" }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call." } } }, "create": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project}/locations/{location}`", "type": "string", "location": "path", "required": true } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1HyperparameterTuningJob" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1HyperparameterTuningJob" }, "description": "Creates a HyperparameterTuningJob", "id": "aiplatform.projects.locations.hyperparameterTuningJobs.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+parent}/hyperparameterTuningJobs", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs" }, "cancel": { "httpMethod": "POST", "id": "aiplatform.projects.locations.hyperparameterTuningJobs.cancel", "path": "v1beta1/{+name}:cancel", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$", "location": "path", "description": "Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1CancelHyperparameterTuningJobRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and HyperparameterTuningJob.state is set to `CANCELLED`." } } }, "operations": { "methods": { "list": { "parameters": { "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "name": { "required": true, "description": "The name of the operation's parent resource.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "pageSize": { "location": "query", "description": "The standard list page size.", "type": "integer", "format": "int32" } }, "httpMethod": "GET", "id": "aiplatform.projects.locations.operations.list", "path": "v1beta1/{+name}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" } }, "wait": { "httpMethod": "POST", "parameterOrder": [ "name" ], "parameters": { "timeout": { "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "format": "google-duration" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string", "description": "The name of the operation resource to wait on.", "location": "path" } }, "path": "v1beta1/{+name}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.operations.wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "The name of the operation resource to be deleted.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string" } }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.projects.locations.operations.delete" }, "cancel": { "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be cancelled.", "type": "string", "required": true } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "id": "aiplatform.projects.locations.operations.cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}:cancel" }, "get": { "httpMethod": "GET", "parameters": { "name": { "location": "path", "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "id": "aiplatform.projects.locations.operations.get", "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "GoogleLongrunningOperation" } } } }, "endpoints": { "resources": { "openapi": { "methods": { "responses": { "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", "parameterOrder": [ "endpoint" ], "request": { "$ref": "GoogleApiHttpBody" }, "response": { "$ref": "GoogleApiHttpBody" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/openapi/responses", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "httpMethod": "POST", "id": "aiplatform.projects.locations.endpoints.openapi.responses", "path": "v1beta1/{+endpoint}/responses", "parameters": { "deployedModelId": { "description": "ID of the DeployedModel that serves the invoke request.", "location": "query", "type": "string" }, "endpoint": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/openapi$", "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "location": "path", "required": true } } }, "completions": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "httpMethod": "POST", "parameters": { "endpoint": { "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/openapi$", "required": true, "type": "string", "location": "path" }, "deployedModelId": { "description": "ID of the DeployedModel that serves the invoke request.", "type": "string", "location": "query" } }, "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", "id": "aiplatform.projects.locations.endpoints.openapi.completions", "response": { "$ref": "GoogleApiHttpBody" }, "parameterOrder": [ "endpoint" ], "request": { "$ref": "GoogleApiHttpBody" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/openapi/completions", "path": "v1beta1/{+endpoint}/completions" }, "embeddings": { "httpMethod": "POST", "request": { "$ref": "GoogleApiHttpBody" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "parameterOrder": [ "endpoint" ], "parameters": { "deployedModelId": { "description": "ID of the DeployedModel that serves the invoke request.", "location": "query", "type": "string" }, "endpoint": { "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/openapi$", "required": true, "type": "string", "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "location": "path" } }, "id": "aiplatform.projects.locations.endpoints.openapi.embeddings", "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", "path": "v1beta1/{+endpoint}/embeddings", "response": { "$ref": "GoogleApiHttpBody" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/openapi/embeddings" } } }, "responses": { "methods": { "delete": { "path": "v1beta1/{+name}", "description": "Deletes the response from the endpoint.", "id": "aiplatform.projects.locations.endpoints.responses.delete", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleApiHttpBody" }, "parameters": { "name": { "required": true, "location": "path", "description": "Required. The name of the Response resource to be deleted. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}/responses/{response}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/responses/[^/]+$" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/responses/{responsesId}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] }, "get": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "id": "aiplatform.projects.locations.endpoints.responses.get", "description": "Gets the response from the endpoint.", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/responses/[^/]+$", "required": true, "description": "Required. The name of the Response resource. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}/responses/{response}`", "location": "path" } }, "parameterOrder": [ "name" ], "httpMethod": "GET", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/responses/{responsesId}", "response": { "$ref": "GoogleApiHttpBody" } } } }, "invoke": { "methods": { "invoke": { "path": "v1beta1/{+endpoint}/invoke/{+invokeId}", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1InvokeRequest" }, "response": { "$ref": "GoogleApiHttpBody" }, "parameters": { "endpoint": { "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "location": "path", "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "type": "string", "required": true }, "invokeId": { "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "endpoint", "invokeId" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/invoke/{invokeId}", "id": "aiplatform.projects.locations.endpoints.invoke.invoke", "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request." } } }, "google": { "resources": { "science": { "methods": { "inference": { "id": "aiplatform.projects.locations.endpoints.google.science.inference", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/google/science/inference", "request": { "$ref": "GoogleApiHttpBody" }, "response": { "$ref": "GoogleApiHttpBody" }, "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "parameters": { "endpoint": { "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/google$", "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "type": "string", "required": true, "location": "path" }, "deployedModelId": { "description": "ID of the DeployedModel that serves the invoke request.", "location": "query", "type": "string" } }, "path": "v1beta1/{+endpoint}/science/inference", "httpMethod": "POST", "parameterOrder": [ "endpoint" ] } } } } }, "chat": { "methods": { "completions": { "path": "v1beta1/{+endpoint}/chat/completions", "request": { "$ref": "GoogleApiHttpBody" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "id": "aiplatform.projects.locations.endpoints.chat.completions", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/chat/completions", "response": { "$ref": "GoogleApiHttpBody" }, "description": "Exposes an OpenAI-compatible endpoint for chat completions.", "httpMethod": "POST", "parameters": { "endpoint": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "location": "path", "description": "Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "required": true } }, "parameterOrder": [ "endpoint" ] } } }, "operations": { "methods": { "list": { "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations", "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v1beta1/{+name}/operations", "id": "aiplatform.projects.locations.endpoints.operations.list", "parameters": { "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "pageSize": { "type": "integer", "location": "query", "description": "The standard list page size.", "format": "int32" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "type": "string", "required": true, "description": "The name of the operation's parent resource.", "location": "path" }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" } }, "get": { "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}", "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$" } }, "httpMethod": "GET", "id": "aiplatform.projects.locations.endpoints.operations.get" }, "delete": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to be deleted.", "type": "string", "location": "path" } }, "id": "aiplatform.projects.locations.endpoints.operations.delete", "httpMethod": "DELETE", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" } }, "wait": { "parameters": { "timeout": { "format": "google-duration", "location": "query", "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." }, "name": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to wait on.", "required": true } }, "path": "v1beta1/{+name}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "id": "aiplatform.projects.locations.endpoints.operations.wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:wait" }, "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:cancel", "path": "v1beta1/{+name}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.projects.locations.endpoints.operations.cancel", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be cancelled.", "required": true } }, "httpMethod": "POST" } } }, "deployedModels": { "resources": { "invoke": { "methods": { "invoke": { "id": "aiplatform.projects.locations.endpoints.deployedModels.invoke.invoke", "parameterOrder": [ "endpoint", "deployedModelId", "invokeId" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1InvokeRequest" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/deployedModels/{deployedModelId}/invoke/{invokeId}", "parameters": { "endpoint": { "location": "path", "required": true, "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "type": "string" }, "deployedModelId": { "location": "path", "required": true, "type": "string", "description": "ID of the DeployedModel that serves the invoke request." }, "invokeId": { "location": "path", "required": true, "type": "string" } }, "path": "v1beta1/{+endpoint}/deployedModels/{deployedModelId}/invoke/{+invokeId}", "httpMethod": "POST", "response": { "$ref": "GoogleApiHttpBody" }, "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request." } } } } } }, "methods": { "streamRawPredict": { "parameterOrder": [ "endpoint" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamRawPredict", "response": { "$ref": "GoogleApiHttpBody" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "httpMethod": "POST", "description": "Perform a streaming online prediction with an arbitrary HTTP payload.", "parameters": { "endpoint": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "description": "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}`" } }, "path": "v1beta1/{+endpoint}:streamRawPredict", "request": { "$ref": "GoogleCloudAiplatformV1beta1StreamRawPredictRequest" }, "id": "aiplatform.projects.locations.endpoints.streamRawPredict" }, "rawPredict": { "description": "Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:rawPredict", "parameterOrder": [ "endpoint" ], "response": { "$ref": "GoogleApiHttpBody" }, "parameters": { "endpoint": { "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "required": true, "type": "string", "location": "path" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1RawPredictRequest" }, "path": "v1beta1/{+endpoint}:rawPredict", "id": "aiplatform.projects.locations.endpoints.rawPredict", "httpMethod": "POST" }, "directPredict": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directPredict", "response": { "$ref": "GoogleCloudAiplatformV1beta1DirectPredictResponse" }, "description": "Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks.", "httpMethod": "POST", "path": "v1beta1/{+endpoint}:directPredict", "parameters": { "endpoint": { "required": true, "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "location": "path" } }, "parameterOrder": [ "endpoint" ], "id": "aiplatform.projects.locations.endpoints.directPredict", "request": { "$ref": "GoogleCloudAiplatformV1beta1DirectPredictRequest" } }, "explain": { "id": "aiplatform.projects.locations.endpoints.explain", "parameterOrder": [ "endpoint" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1ExplainResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:explain", "httpMethod": "POST", "parameters": { "endpoint": { "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "location": "path", "description": "Required. The name of the Endpoint requested to serve the explanation. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "type": "string", "required": true } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1ExplainRequest" }, "path": "v1beta1/{+endpoint}:explain", "description": "Perform an online explanation. If deployed_model_id is specified, the corresponding DeployModel must have explanation_spec populated. If deployed_model_id is not specified, all DeployedModels must have explanation_spec populated.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] }, "patch": { "id": "aiplatform.projects.locations.endpoints.patch", "description": "Updates an Endpoint.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", "response": { "$ref": "GoogleCloudAiplatformV1beta1Endpoint" }, "parameters": { "updateMask": { "format": "google-fieldmask", "type": "string", "location": "query", "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask." }, "name": { "description": "Identifier. The resource name of the Endpoint.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "type": "string", "location": "path" } }, "path": "v1beta1/{+name}", "httpMethod": "PATCH", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1Endpoint" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "fetchPredictOperation": { "parameters": { "endpoint": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "description": "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}`" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:fetchPredictOperation", "request": { "$ref": "GoogleCloudAiplatformV1beta1FetchPredictOperationRequest" }, "id": "aiplatform.projects.locations.endpoints.fetchPredictOperation", "description": "Fetch an asynchronous online prediction operation.", "path": "v1beta1/{+endpoint}:fetchPredictOperation", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "parameterOrder": [ "endpoint" ] }, "list": { "path": "v1beta1/{+parent}/endpoints", "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints", "parameters": { "filter": { "type": "string", "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports `=` and `!=`. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:*` or `labels:key` - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `base_model_name` only supports `=`. Some examples: * `endpoint=1` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`", "location": "query" }, "gdcZone": { "description": "Optional. Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment.", "type": "string", "location": "query" }, "pageToken": { "description": "Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call.", "location": "query", "type": "string" }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "Optional. The standard list page size." }, "parent": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project}/locations/{location}`", "location": "path" }, "readMask": { "format": "google-fieldmask", "description": "Optional. Mask specifying which fields to read.", "type": "string", "location": "query" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1ListEndpointsResponse" }, "id": "aiplatform.projects.locations.endpoints.list", "description": "Lists Endpoints in a Location.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ] }, "get": { "description": "Gets an Endpoint.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.endpoints.get", "response": { "$ref": "GoogleCloudAiplatformV1beta1Endpoint" }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", "parameters": { "name": { "description": "Required. The name of the Endpoint resource. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$" } } }, "generateContent": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:generateContent", "request": { "$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" }, "response": { "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" }, "parameterOrder": [ "model" ], "path": "v1beta1/{+model}:generateContent", "httpMethod": "POST", "description": "Generate content with multimodal inputs.", "parameters": { "model": { "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "location": "path", "type": "string", "description": "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": true } }, "id": "aiplatform.projects.locations.endpoints.generateContent" }, "getIamPolicy": { "response": { "$ref": "GoogleIamV1Policy" }, "path": "v1beta1/{+resource}:getIamPolicy", "id": "aiplatform.projects.locations.endpoints.getIamPolicy", "httpMethod": "POST", "parameterOrder": [ "resource" ], "parameters": { "resource": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "location": "path", "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "required": true }, "options.requestedPolicyVersion": { "type": "integer", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:getIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set." }, "update": { "httpMethod": "POST", "id": "aiplatform.projects.locations.endpoints.update", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Identifier. The resource name of the Endpoint." } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1UpdateEndpointLongRunningRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:update", "description": "Updates an Endpoint with a long running operation.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:update" }, "predict": { "request": { "$ref": "GoogleCloudAiplatformV1beta1PredictRequest" }, "parameterOrder": [ "endpoint" ], "description": "", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predict", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "httpMethod": "POST", "id": "aiplatform.projects.locations.endpoints.predict", "path": "v1beta1/{+endpoint}:predict", "parameters": { "endpoint": { "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "location": "path", "required": true } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1PredictResponse" } }, "undeployModel": { "id": "aiplatform.projects.locations.endpoints.undeployModel", "path": "v1beta1/{+endpoint}:undeployModel", "parameters": { "endpoint": { "location": "path", "description": "Required. The name of the Endpoint resource from which to undeploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "type": "string" } }, "httpMethod": "POST", "description": "Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.", "parameterOrder": [ "endpoint" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:undeployModel", "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1UndeployModelRequest" } }, "setIamPolicy": { "httpMethod": "POST", "parameters": { "resource": { "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "location": "path", "required": true } }, "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+resource}:setIamPolicy", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:setIamPolicy", "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "id": "aiplatform.projects.locations.endpoints.setIamPolicy", "response": { "$ref": "GoogleIamV1Policy" } }, "delete": { "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.endpoints.delete", "parameterOrder": [ "name" ], "description": "Deletes an Endpoint.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "location": "path", "required": true, "description": "Required. The name of the Endpoint resource to be deleted. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "type": "string" } }, "path": "v1beta1/{+name}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "directRawPredict": { "parameterOrder": [ "endpoint" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1DirectRawPredictRequest" }, "httpMethod": "POST", "parameters": { "endpoint": { "location": "path", "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1DirectRawPredictResponse" }, "path": "v1beta1/{+endpoint}:directRawPredict", "id": "aiplatform.projects.locations.endpoints.directRawPredict", "description": "Perform an unary online prediction request to a gRPC model server for custom containers.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directRawPredict" }, "deployModel": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:deployModel", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Deploys a Model into this Endpoint, creating a DeployedModel within it.", "path": "v1beta1/{+endpoint}:deployModel", "id": "aiplatform.projects.locations.endpoints.deployModel", "parameterOrder": [ "endpoint" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1DeployModelRequest" }, "parameters": { "endpoint": { "required": true, "type": "string", "description": "Required. The name of the Endpoint resource into which to deploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST" }, "create": { "path": "v1beta1/{+parent}/endpoints", "request": { "$ref": "GoogleCloudAiplatformV1beta1Endpoint" }, "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.endpoints.create", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints", "httpMethod": "POST", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "location": "path", "type": "string", "description": "Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project}/locations/{location}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" }, "endpointId": { "type": "string", "location": "query", "description": "Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body." } }, "description": "Creates an Endpoint." }, "computeTokens": { "parameters": { "endpoint": { "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "required": true, "description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", "type": "string", "location": "path" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:computeTokens", "httpMethod": "POST", "response": { "$ref": "GoogleCloudAiplatformV1beta1ComputeTokensResponse" }, "description": "Return a list of tokens based on the input text.", "request": { "$ref": "GoogleCloudAiplatformV1beta1ComputeTokensRequest" }, "path": "v1beta1/{+endpoint}:computeTokens", "id": "aiplatform.projects.locations.endpoints.computeTokens", "parameterOrder": [ "endpoint" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "predictLongRunning": { "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1PredictLongRunningRequest" }, "parameters": { "endpoint": { "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "type": "string", "required": true, "description": "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}`", "location": "path" } }, "id": "aiplatform.projects.locations.endpoints.predictLongRunning", "path": "v1beta1/{+endpoint}:predictLongRunning", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "description": "", "parameterOrder": [ "endpoint" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predictLongRunning" }, "serverStreamingPredict": { "parameters": { "endpoint": { "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "location": "path", "type": "string", "required": true, "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`" } }, "httpMethod": "POST", "path": "v1beta1/{+endpoint}:serverStreamingPredict", "response": { "$ref": "GoogleCloudAiplatformV1beta1StreamingPredictResponse" }, "id": "aiplatform.projects.locations.endpoints.serverStreamingPredict", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "parameterOrder": [ "endpoint" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:serverStreamingPredict", "description": "Perform a server-side streaming online prediction request for Vertex LLM streaming.", "request": { "$ref": "GoogleCloudAiplatformV1beta1StreamingPredictRequest" } }, "mutateDeployedModel": { "parameters": { "endpoint": { "required": true, "description": "Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$" } }, "httpMethod": "POST", "parameterOrder": [ "endpoint" ], "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+endpoint}:mutateDeployedModel", "description": "Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `required_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1MutateDeployedModelRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:mutateDeployedModel", "id": "aiplatform.projects.locations.endpoints.mutateDeployedModel" }, "countTokens": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "httpMethod": "POST", "description": "Perform a token counting.", "request": { "$ref": "GoogleCloudAiplatformV1beta1CountTokensRequest" }, "path": "v1beta1/{+endpoint}:countTokens", "parameters": { "endpoint": { "required": true, "type": "string", "description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1CountTokensResponse" }, "id": "aiplatform.projects.locations.endpoints.countTokens", "parameterOrder": [ "endpoint" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:countTokens" }, "testIamPermissions": { "id": "aiplatform.projects.locations.endpoints.testIamPermissions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "parameterOrder": [ "resource" ], "path": "v1beta1/{+resource}:testIamPermissions", "parameters": { "resource": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "required": true, "type": "string", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field." }, "permissions": { "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", "repeated": true, "location": "query", "type": "string" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:testIamPermissions", "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning." }, "streamGenerateContent": { "parameterOrder": [ "model" ], "httpMethod": "POST", "parameters": { "model": { "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "type": "string", "location": "path", "description": "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": true } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamGenerateContent", "path": "v1beta1/{+model}:streamGenerateContent", "response": { "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" }, "id": "aiplatform.projects.locations.endpoints.streamGenerateContent", "request": { "$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" }, "description": "Generate content with multimodal inputs with streaming support.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] } } }, "reasoningEngines": { "methods": { "list": { "path": "v1beta1/{+parent}/reasoningEngines", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "description": "Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`" }, "filter": { "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. The standard list page size.", "type": "integer", "format": "int32", "location": "query" }, "pageToken": { "type": "string", "description": "Optional. The standard list page token.", "location": "query" } }, "id": "aiplatform.projects.locations.reasoningEngines.list", "description": "Lists reasoning engines in a location.", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines", "parameterOrder": [ "parent" ] }, "patch": { "description": "Updates a reasoning engine.", "id": "aiplatform.projects.locations.reasoningEngines.patch", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "request": { "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" }, "parameterOrder": [ "name" ], "httpMethod": "PATCH", "parameters": { "updateMask": { "description": "Optional. Mask specifying which fields to update.", "location": "query", "type": "string", "format": "google-fieldmask" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`" } } }, "delete": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "description": "Deletes a reasoning engine.", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.reasoningEngines.delete", "httpMethod": "DELETE", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "location": "path", "description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string", "required": true }, "force": { "location": "query", "type": "boolean", "description": "Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources." } }, "response": { "$ref": "GoogleLongrunningOperation" } }, "setIamPolicy": { "parameterOrder": [ "resource" ], "request": { "$ref": "GoogleIamV1SetIamPolicyRequest" }, "httpMethod": "POST", "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "location": "path", "type": "string", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+resource}:setIamPolicy", "response": { "$ref": "GoogleIamV1Policy" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:setIamPolicy", "id": "aiplatform.projects.locations.reasoningEngines.setIamPolicy" }, "executeCode": { "id": "aiplatform.projects.locations.reasoningEngines.executeCode", "request": { "$ref": "GoogleCloudAiplatformV1beta1ExecuteCodeRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1ExecuteCodeResponse" }, "parameters": { "name": { "location": "path", "type": "string", "required": true, "description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$" } }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:executeCode", "httpMethod": "POST", "path": "v1beta1/{+name}:executeCode", "description": "Executes code statelessly." }, "asyncQuery": { "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:asyncQuery", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Async query using a reasoning engine.", "request": { "$ref": "GoogleCloudAiplatformV1beta1AsyncQueryReasoningEngineRequest" }, "path": "v1beta1/{+name}:asyncQuery", "parameters": { "name": { "location": "path", "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$" } }, "id": "aiplatform.projects.locations.reasoningEngines.asyncQuery", "httpMethod": "POST" }, "getIamPolicy": { "response": { "$ref": "GoogleIamV1Policy" }, "parameterOrder": [ "resource" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:getIamPolicy", "id": "aiplatform.projects.locations.reasoningEngines.getIamPolicy", "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "options.requestedPolicyVersion": { "type": "integer", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query" }, "resource": { "required": true, "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "location": "path" } }, "path": "v1beta1/{+resource}:getIamPolicy" }, "get": { "response": { "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.reasoningEngines.get", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}", "description": "Gets a reasoning engine.", "parameters": { "name": { "description": "Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "location": "path", "required": true } }, "httpMethod": "GET" }, "cancelAsyncQuery": { "path": "v1beta1/{+name}:cancelAsyncQuery", "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`" } }, "httpMethod": "POST", "id": "aiplatform.projects.locations.reasoningEngines.cancelAsyncQuery", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1CancelAsyncQueryReasoningEngineRequest" }, "response": { "$ref": "GoogleCloudAiplatformV1beta1CancelAsyncQueryReasoningEngineResponse" }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:cancelAsyncQuery", "description": "Cancels an AsyncQueryReasoningEngine operation." }, "testIamPermissions": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:testIamPermissions", "path": "v1beta1/{+resource}:testIamPermissions", "id": "aiplatform.projects.locations.reasoningEngines.testIamPermissions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "parameters": { "resource": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "required": true }, "permissions": { "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", "repeated": true, "type": "string", "location": "query" } }, "parameterOrder": [ "resource" ], "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "httpMethod": "POST" }, "streamQuery": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:streamQuery", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1StreamQueryReasoningEngineRequest" }, "id": "aiplatform.projects.locations.reasoningEngines.streamQuery", "description": "Streams queries using a reasoning engine.", "path": "v1beta1/{+name}:streamQuery", "response": { "$ref": "GoogleApiHttpBody" } }, "create": { "path": "v1beta1/{+parent}/reasoningEngines", "request": { "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" }, "description": "Creates a reasoning engine.", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines", "id": "aiplatform.projects.locations.reasoningEngines.create", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "location": "path", "description": "Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true } } }, "query": { "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$" } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineRequest" }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineResponse" }, "id": "aiplatform.projects.locations.reasoningEngines.query", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:query", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:query", "description": "Queries using a reasoning engine." } }, "resources": { "runtimeRevisions": { "methods": { "query": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}:query", "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.query", "httpMethod": "POST", "response": { "$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineResponse" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineRequest" }, "path": "v1beta1/{+name}:query", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "location": "path", "type": "string", "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true } }, "description": "Queries using a reasoning engine.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "parameters": { "name": { "description": "Required. The name of the ReasoningEngineRuntimeRevision resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/runtimeRevisions/{runtimeRevision}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "location": "path" } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.get", "description": "Gets a reasoning engine runtime revision.", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineRuntimeRevision" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}" }, "delete": { "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.delete", "parameters": { "name": { "description": "Required. The name of the ReasoningEngineRuntimeRevision resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/runtimeRevisions/{runtime_revision}`", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a reasoning engine revision." }, "streamQuery": { "description": "Streams queries using a reasoning engine.", "path": "v1beta1/{+name}:streamQuery", "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.streamQuery", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleApiHttpBody" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}:streamQuery", "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1StreamQueryReasoningEngineRequest" }, "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true } } }, "list": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListReasoningEngineRuntimeRevisionsResponse" }, "description": "Lists runtime revisions in a reasoning engine.", "parameters": { "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "Optional. The maximum number of ReasoningEngineRuntimeRevisions to return. The service may return fewer than this value. If unspecified, at most 50 revisions will be returned. The maximum value is 100; values above 100 will be coerced to 100." }, "parent": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "description": "Required. The resource name of the ReasoningEngine to list the ReasoningEngineRuntimeRevisions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`" }, "filter": { "location": "query", "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The standard list page token." } }, "parameterOrder": [ "parent" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+parent}/runtimeRevisions", "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.list" } }, "resources": { "a2a": { "methods": { "card": { "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.card", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/card", "parameterOrder": [ "name", "a2aEndpoint" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true }, "a2aEndpoint": { "required": true, "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "location": "path", "pattern": "^card$", "type": "string" }, "historyLength": { "type": "string", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "location": "query" } } }, "extendedAgentCard": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/extendedAgentCard", "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "response": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "parameterOrder": [ "name", "a2aEndpoint" ], "httpMethod": "GET", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.extendedAgentCard", "parameters": { "name": { "location": "path", "type": "string", "required": true, "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$" }, "historyLength": { "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "type": "string", "location": "query" }, "a2aEndpoint": { "required": true, "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "location": "path", "type": "string", "pattern": "^extendedAgentCard$" } } }, "tasks": { "parameters": { "historyLength": { "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "type": "string", "location": "query" }, "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$" }, "a2aEndpoint": { "pattern": "^tasks$", "location": "path", "type": "string", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "required": true } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks", "httpMethod": "GET", "response": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "parameterOrder": [ "name", "a2aEndpoint" ], "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.tasks" } }, "resources": { "message": { "methods": { "send": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name", "a2aEndpoint" ], "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:send", "parameters": { "a2aEndpoint": { "pattern": "^message$", "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", "type": "string", "location": "path", "required": true }, "name": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "location": "path" } }, "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.message.send", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/message:send", "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "request": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" } }, "stream": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name", "a2aEndpoint" ], "request": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "httpMethod": "POST", "parameters": { "a2aEndpoint": { "location": "path", "required": true, "pattern": "^message$", "description": "Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.", "type": "string" }, "name": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "required": true } }, "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.message.stream", "description": "Streams queries using a reasoning engine instance via the A2A streaming protocol apis.", "response": { "$ref": "GoogleApiHttpBody" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/message:stream", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:stream" } } }, "v1": { "resources": { "message": { "methods": { "stream": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/message:stream", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleApiHttpBody" }, "parameterOrder": [ "name", "a2aEndpoint" ], "description": "Streams queries using a reasoning engine instance via the A2A streaming protocol apis.", "parameters": { "a2aEndpoint": { "description": "Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.", "pattern": "^v1/message$", "type": "string", "location": "path", "required": true }, "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "location": "path", "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "required": true } }, "httpMethod": "POST", "request": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.message.stream", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:stream" }, "send": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "a2aEndpoint": { "required": true, "pattern": "^v1/message$", "type": "string", "location": "path", "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "location": "path", "type": "string", "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "required": true } }, "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:send", "httpMethod": "POST", "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.message.send", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/message:send", "request": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", "parameterOrder": [ "name", "a2aEndpoint" ] } } }, "tasks": { "methods": { "cancel": { "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}:cancel", "request": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "httpMethod": "POST", "parameters": { "name": { "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "description": "Required. The full resource path of the reasoning engine, captured from the URL." }, "a2aEndpoint": { "location": "path", "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", "required": true, "type": "string", "pattern": "^v1/tasks/[^/]+$" } }, "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.tasks.cancel", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel", "parameterOrder": [ "name", "a2aEndpoint" ] }, "subscribe": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}:subscribe", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe", "parameterOrder": [ "name", "a2aEndpoint" ], "description": "Stream get request for reasoning engine instance via the A2A stream get protocol apis.", "httpMethod": "GET", "response": { "$ref": "GoogleApiHttpBody" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "required": true, "location": "path", "type": "string" }, "a2aEndpoint": { "required": true, "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.", "location": "path", "pattern": "^v1/tasks/[^/]+$", "type": "string" } }, "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.tasks.subscribe" }, "pushNotificationConfigs": { "parameterOrder": [ "name", "a2aEndpoint" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "parameters": { "a2aEndpoint": { "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "pattern": "^v1/tasks/[^/]+/pushNotificationConfigs$", "required": true, "type": "string", "location": "path" }, "historyLength": { "type": "string", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "location": "query" }, "name": { "location": "path", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "response": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs", "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.tasks.pushNotificationConfigs" }, "a2aGetReasoningEngine": { "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.tasks.a2aGetReasoningEngine", "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "parameterOrder": [ "name", "a2aEndpoint" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}", "parameters": { "historyLength": { "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "location": "query", "type": "string" }, "name": { "location": "path", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" }, "a2aEndpoint": { "type": "string", "required": true, "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "pattern": "^v1/tasks/[^/]+$", "location": "path" } }, "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}" } }, "resources": { "pushNotificationConfigs": { "methods": { "a2aGetReasoningEngine": { "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "parameterOrder": [ "name", "a2aEndpoint" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.tasks.pushNotificationConfigs.a2aGetReasoningEngine", "parameters": { "historyLength": { "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "type": "string", "location": "query" }, "a2aEndpoint": { "location": "path", "type": "string", "required": true, "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "pattern": "^v1/tasks/[^/]+/pushNotificationConfigs/[^/]+$" }, "name": { "required": true, "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "location": "path", "type": "string" } }, "httpMethod": "GET" } } } } } }, "methods": { "extendedAgentCard": { "httpMethod": "GET", "parameters": { "a2aEndpoint": { "type": "string", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "pattern": "^v1/extendedAgentCard$", "required": true, "location": "path" }, "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "location": "path", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true }, "historyLength": { "type": "string", "location": "query", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned." } }, "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "parameterOrder": [ "name", "a2aEndpoint" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/extendedAgentCard", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.extendedAgentCard", "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "tasks": { "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.tasks", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "parameters": { "a2aEndpoint": { "location": "path", "type": "string", "pattern": "^v1/tasks$", "required": true, "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`" }, "historyLength": { "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "location": "query", "type": "string" }, "name": { "required": true, "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$" } }, "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "httpMethod": "GET", "parameterOrder": [ "name", "a2aEndpoint" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks", "response": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "card": { "parameterOrder": [ "name", "a2aEndpoint" ], "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/card", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "parameters": { "historyLength": { "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "type": "string", "location": "query" }, "name": { "required": true, "type": "string", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$" }, "a2aEndpoint": { "type": "string", "pattern": "^v1/card$", "location": "path", "required": true, "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`" } }, "httpMethod": "GET", "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.card" } } }, "tasks": { "methods": { "pushNotificationConfigs": { "parameterOrder": [ "name", "a2aEndpoint" ], "httpMethod": "GET", "parameters": { "historyLength": { "location": "query", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "type": "string" }, "a2aEndpoint": { "pattern": "^tasks/[^/]+/pushNotificationConfigs$", "location": "path", "type": "string", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "required": true }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}/pushNotificationConfigs", "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.tasks.pushNotificationConfigs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "response": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}" }, "subscribe": { "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.tasks.subscribe", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe", "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}:subscribe", "parameters": { "name": { "location": "path", "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" }, "a2aEndpoint": { "required": true, "type": "string", "location": "path", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.", "pattern": "^tasks/[^/]+$" } }, "parameterOrder": [ "name", "a2aEndpoint" ], "description": "Stream get request for reasoning engine instance via the A2A stream get protocol apis.", "response": { "$ref": "GoogleApiHttpBody" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "cancel": { "parameters": { "name": { "location": "path", "type": "string", "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$" }, "a2aEndpoint": { "required": true, "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", "pattern": "^tasks/[^/]+$", "location": "path", "type": "string" } }, "httpMethod": "POST", "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.tasks.cancel", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel", "request": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "parameterOrder": [ "name", "a2aEndpoint" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}:cancel", "description": "Send post request for reasoning engine instance via the A2A post protocol apis." }, "a2aGetReasoningEngine": { "parameters": { "a2aEndpoint": { "type": "string", "pattern": "^tasks/[^/]+$", "required": true, "location": "path", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`" }, "historyLength": { "type": "string", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "location": "query" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "type": "string", "location": "path", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true } }, "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "response": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "httpMethod": "GET", "parameterOrder": [ "name", "a2aEndpoint" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}", "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.tasks.a2aGetReasoningEngine", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "pushNotificationConfigs": { "methods": { "a2aGetReasoningEngine": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "parameters": { "historyLength": { "type": "string", "location": "query", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned." }, "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$" }, "a2aEndpoint": { "required": true, "type": "string", "pattern": "^tasks/[^/]+/pushNotificationConfigs/[^/]+$", "location": "path", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`" } }, "parameterOrder": [ "name", "a2aEndpoint" ], "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.tasks.pushNotificationConfigs.a2aGetReasoningEngine", "response": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" } } } } } } } }, "operations": { "methods": { "wait": { "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}:wait", "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.operations.wait", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}:wait", "parameters": { "name": { "description": "The name of the operation resource to wait on.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", "location": "path" }, "timeout": { "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "format": "google-duration" } }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameterOrder": [ "name" ] }, "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations", "path": "v1beta1/{+name}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.operations.list", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "location": "path", "description": "The name of the operation's parent resource.", "type": "string" }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "pageSize": { "format": "int32", "description": "The standard list page size.", "type": "integer", "location": "query" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" } } }, "delete": { "path": "v1beta1/{+name}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to be deleted.", "type": "string" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}", "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.operations.delete", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" } }, "cancel": { "parameterOrder": [ "name" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation resource to be cancelled.", "required": true } }, "path": "v1beta1/{+name}:cancel", "httpMethod": "POST", "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.operations.cancel" }, "get": { "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}", "httpMethod": "GET", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "description": "The name of the operation resource.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", "location": "path" } }, "id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.operations.get", "path": "v1beta1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } } } } }, "examples": { "resources": { "operations": { "methods": { "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.reasoningEngines.examples.operations.delete", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", "type": "string", "location": "path", "description": "The name of the operation resource to be deleted.", "required": true } }, "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "parameters": { "name": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", "description": "The name of the operation resource.", "location": "path" } }, "httpMethod": "GET", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.reasoningEngines.examples.operations.get" }, "cancel": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "description": "The name of the operation resource to be cancelled.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$" } }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}:cancel", "path": "v1beta1/{+name}:cancel", "id": "aiplatform.projects.locations.reasoningEngines.examples.operations.cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" } }, "wait": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to wait on." }, "timeout": { "format": "google-duration", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string" } }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "id": "aiplatform.projects.locations.reasoningEngines.examples.operations.wait", "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}:wait", "parameterOrder": [ "name" ] } } } } }, "operations": { "methods": { "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be deleted.", "type": "string", "required": true } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", "id": "aiplatform.projects.locations.reasoningEngines.operations.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "path": "v1beta1/{+name}" }, "get": { "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "GET", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", "required": true, "type": "string", "description": "The name of the operation resource." } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.reasoningEngines.operations.get", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "path": "v1beta1/{+name}" }, "wait": { "path": "v1beta1/{+name}:wait", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "id": "aiplatform.projects.locations.reasoningEngines.operations.wait", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:wait", "parameters": { "timeout": { "format": "google-duration", "location": "query", "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." }, "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to wait on.", "type": "string" } }, "response": { "$ref": "GoogleLongrunningOperation" } }, "cancel": { "id": "aiplatform.projects.locations.reasoningEngines.operations.cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:cancel", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", "required": true, "location": "path", "type": "string" } }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:cancel", "response": { "$ref": "GoogleProtobufEmpty" } }, "list": { "httpMethod": "GET", "parameters": { "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "pageSize": { "type": "integer", "description": "The standard list page size.", "format": "int32", "location": "query" }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "type": "string", "required": true, "description": "The name of the operation's parent resource." } }, "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.reasoningEngines.operations.list", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations", "path": "v1beta1/{+name}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "response": { "$ref": "GoogleLongrunningListOperationsResponse" } } } }, "sessions": { "methods": { "get": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$" } }, "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.reasoningEngines.sessions.get", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", "description": "Gets details of the specific Session.", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleCloudAiplatformV1beta1Session" } }, "delete": { "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.reasoningEngines.sessions.delete", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", "description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", "type": "string", "location": "path", "required": true } }, "parameterOrder": [ "name" ], "description": "Deletes details of the specific Session." }, "compact": { "path": "v1beta1/{+name}:compact", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1CompactSessionRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}:compact", "description": "Compacts the event history of a given Session, which may run an LLM summarization call and rewrite the full event history. Compaction is a storage-side rewrite that can apply a stackable pipeline of rules (event-horizon preservation, tool-response truncation, thought stripping, and LLM summarization etc.)", "id": "aiplatform.projects.locations.reasoningEngines.sessions.compact", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", "description": "Required. The resource name of the session to compact. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`" } }, "httpMethod": "POST", "parameterOrder": [ "name" ] }, "list": { "parameters": { "pageToken": { "location": "query", "description": "Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.", "type": "string" }, "pageSize": { "location": "query", "type": "integer", "description": "Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, the default page size is 100. Values greater than 100 will be capped at 100.", "format": "int32" }, "filter": { "location": "query", "type": "string", "description": "Optional. The standard list filter. Supported fields: * `display_name` * `user_id` * `labels` Example: `display_name=\"abc\"`, `user_id=\"123\"`, `labels.key=\"value\"`." }, "orderBy": { "type": "string", "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.", "location": "query" }, "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "description": "Required. The resource name of the location to list sessions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string", "location": "path" } }, "httpMethod": "GET", "description": "Lists Sessions in a given reasoning engine.", "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/sessions", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListSessionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.reasoningEngines.sessions.list", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions" }, "appendEvent": { "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1SessionEvent" }, "response": { "$ref": "GoogleCloudAiplatformV1beta1AppendEventResponse" }, "path": "v1beta1/{+name}:appendEvent", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.reasoningEngines.sessions.appendEvent", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}:appendEvent", "parameters": { "name": { "description": "Required. The resource name of the session to append event to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", "required": true, "location": "path" } }, "httpMethod": "POST", "description": "Appends an event to a given session." }, "patch": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", "request": { "$ref": "GoogleCloudAiplatformV1beta1Session" }, "response": { "$ref": "GoogleCloudAiplatformV1beta1Session" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the specific Session.", "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.reasoningEngines.sessions.patch", "httpMethod": "PATCH", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "type": "string", "description": "Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$" }, "updateMask": { "format": "google-fieldmask", "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", "type": "string", "location": "query" } } }, "create": { "description": "Creates a new Session.", "httpMethod": "POST", "id": "aiplatform.projects.locations.reasoningEngines.sessions.create", "parameters": { "sessionId": { "location": "query", "description": "Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first and last characters must be a letter or number.", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "location": "path", "description": "Required. The resource name of the location to create the session in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true, "type": "string" } }, "path": "v1beta1/{+parent}/sessions", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1Session" } } }, "resources": { "operations": { "methods": { "list": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", "type": "string", "description": "The name of the operation's parent resource.", "location": "path" }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "returnPartialSuccess": { "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query" }, "pageSize": { "description": "The standard list page size.", "format": "int32", "type": "integer", "location": "query" } }, "path": "v1beta1/{+name}/operations", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.list" }, "cancel": { "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.cancel", "parameterOrder": [ "name" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:cancel", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", "location": "path", "required": true, "description": "The name of the operation resource to be cancelled." } }, "path": "v1beta1/{+name}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "wait": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "path": "v1beta1/{+name}:wait", "parameters": { "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration", "type": "string", "location": "query" }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to wait on.", "type": "string" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.wait", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:wait" }, "delete": { "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation resource to be deleted.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$" } }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.delete", "path": "v1beta1/{+name}" }, "get": { "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}", "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation resource." } }, "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.get" } } }, "events": { "methods": { "list": { "id": "aiplatform.projects.locations.reasoningEngines.sessions.events.list", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/events", "path": "v1beta1/{+parent}/events", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListEventsResponse" }, "description": "Lists Events in a given session.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the session to list events from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`" }, "orderBy": { "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `timestamp` Example: `timestamp desc`.", "type": "string", "location": "query" }, "pageSize": { "description": "Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order.", "type": "integer", "location": "query", "format": "int32" }, "filter": { "type": "string", "location": "query", "description": "Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp\u003e=\"2025-01-31T11:30:00-04:00\"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160)." }, "pageToken": { "type": "string", "location": "query", "description": "Optional. The next_page_token value returned from a previous list SessionService.ListEvents call." } } } } } } }, "sandboxEnvironmentSnapshots": { "resources": { "operations": { "methods": { "cancel": { "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be cancelled." } }, "httpMethod": "POST", "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.cancel", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "path": "v1beta1/{+name}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}:cancel" }, "list": { "path": "v1beta1/{+name}/operations", "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "pageSize": { "format": "int32", "location": "query", "description": "The standard list page size.", "type": "integer" }, "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$", "location": "path", "type": "string", "required": true } }, "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.list", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" } }, "delete": { "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.delete", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", "location": "path", "type": "string" } }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." }, "get": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.get", "path": "v1beta1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "required": true, "description": "The name of the operation resource." } }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "GET", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}" }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "timeout": { "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "format": "google-duration" }, "name": { "location": "path", "description": "The name of the operation resource to wait on.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", "type": "string" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}:wait", "path": "v1beta1/{+name}:wait" } } } }, "methods": { "get": { "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The resource name of the sandbox environment snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentSnapshot" }, "httpMethod": "GET", "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}", "path": "v1beta1/{+name}", "description": "Gets details of the specific SandboxEnvironmentSnapshot." }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.list", "description": "Lists SandboxEnvironmentSnapshots in a given reasoning engine.", "parameterOrder": [ "parent" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots", "httpMethod": "GET", "path": "v1beta1/{+parent}/sandboxEnvironmentSnapshots", "parameters": { "pageToken": { "type": "string", "description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironmentSnapshots` call. Provide this to retrieve the subsequent page.", "location": "query" }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "description": "Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true, "type": "string" }, "filter": { "type": "string", "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", "location": "query" }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The maximum number of SandboxEnvironmentSnapshots to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentSnapshots will be returned. Values above 100 will be coerced to 100.", "location": "query" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentSnapshotsResponse" } }, "delete": { "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$", "description": "Required. The resource name of the SandboxEnvironmentSnapshot to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`" } }, "parameterOrder": [ "name" ], "httpMethod": "DELETE", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Deletes the specific SandboxEnvironmentSnapshot.", "path": "v1beta1/{+name}" } } }, "feedbackEntries": { "methods": { "list": { "path": "v1beta1/{+parent}/feedbackEntries", "parameters": { "orderBy": { "location": "query", "description": "Optional. A comma-separated list of fields to order results by, sorted in ascending order by default. Append ` desc` after a field name to sort that field in descending order. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.", "type": "string" }, "pageSize": { "format": "int32", "description": "Optional. The maximum number of FeedbackEntries to return per page.", "location": "query", "type": "integer" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A page token, received from a previous ListFeedbackEntries call." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "description": "Required. The resource name of the ReasoningEngine from which to list FeedbackEntries. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true, "location": "path", "type": "string" }, "filter": { "type": "string", "description": "Optional. Standard list filter. Supported fields: * `session_id` * `user_id` * `feedback_type` * `feedback_labels`: Supports the HAS operator (`:`). For example: `feedback_labels:\"inaccurate\"`. * `create_time` * `update_time` Example: `feedback_type=\"THUMBS_DOWN\" AND feedback_labels:\"hallucination\"`.", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "id": "aiplatform.projects.locations.reasoningEngines.feedbackEntries.list", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1ListFeedbackEntriesResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries", "description": "Lists FeedbackEntries in a ReasoningEngine." }, "create": { "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "id": "aiplatform.projects.locations.reasoningEngines.feedbackEntries.create", "parameters": { "parent": { "description": "Required. The resource name of the ReasoningEngine in which to create the FeedbackEntry. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "location": "path", "type": "string" } }, "parameterOrder": [ "parent" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1FeedbackEntry" }, "path": "v1beta1/{+parent}/feedbackEntries", "description": "Creates a new FeedbackEntry." }, "patch": { "httpMethod": "PATCH", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "Identifier. The resource name. Assigned by the server on create. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/feedbackEntries/[^/]+$", "type": "string" }, "updateMask": { "format": "google-fieldmask", "type": "string", "description": "Optional. The field mask that controls which fields are updated. If unset or empty, all mutable fields of the FeedbackEntry are replaced with the values from feedback_entry.", "location": "query" } }, "description": "Updates an existing FeedbackEntry. Only the fields specified in update_mask are modified. If the mask is empty, all mutable fields are replaced with the values supplied in the request.", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.reasoningEngines.feedbackEntries.patch", "request": { "$ref": "GoogleCloudAiplatformV1beta1FeedbackEntry" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}" }, "updateFeedbackContext": { "httpMethod": "PATCH", "request": { "$ref": "GoogleCloudAiplatformV1beta1FeedbackContext" }, "parameters": { "name": { "location": "path", "required": true, "description": "Identifier. The resource name. Assigned by the server on create. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}/feedbackContext`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/feedbackEntries/[^/]+/feedbackContext$" }, "updateMask": { "description": "Optional. The field mask that controls which fields are updated. If unset or empty, all mutable fields of the FeedbackContext are replaced with the values from feedback_context.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.reasoningEngines.feedbackEntries.updateFeedbackContext", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/feedbackContext", "description": "Updates the FeedbackContext associated with a FeedbackEntry. Only the fields specified in update_mask are modified. If the mask is empty, all mutable fields are replaced with the values supplied in the request." }, "delete": { "parameters": { "name": { "description": "Required. The resource name of the FeedbackEntry to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}`", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/feedbackEntries/[^/]+$" } }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "httpMethod": "DELETE", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.reasoningEngines.feedbackEntries.delete", "description": "Deletes a FeedbackEntry and its associated FeedbackContext." }, "get": { "parameters": { "name": { "description": "Required. The resource name of the FeedbackEntry to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}`", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/feedbackEntries/[^/]+$", "location": "path", "type": "string", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "httpMethod": "GET", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}", "description": "Retrieves a single FeedbackEntry by its resource name.", "response": { "$ref": "GoogleCloudAiplatformV1beta1FeedbackEntry" }, "id": "aiplatform.projects.locations.reasoningEngines.feedbackEntries.get" }, "getFeedbackContext": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "Required. The resource name of the FeedbackContext to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}/feedbackContext`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/feedbackEntries/[^/]+/feedbackContext$", "required": true } }, "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/feedbackContext", "id": "aiplatform.projects.locations.reasoningEngines.feedbackEntries.getFeedbackContext", "description": "Retrieves the FeedbackContext associated with a FeedbackEntry.", "response": { "$ref": "GoogleCloudAiplatformV1beta1FeedbackContext" } } }, "resources": { "operations": { "methods": { "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.reasoningEngines.feedbackEntries.operations.list", "path": "v1beta1/{+name}/operations", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "pageSize": { "description": "The standard list page size.", "format": "int32", "type": "integer", "location": "query" }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "name": { "required": true, "type": "string", "description": "The name of the operation's parent resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/feedbackEntries/[^/]+$" }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." } } }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations/{operationsId}:wait", "id": "aiplatform.projects.locations.reasoningEngines.feedbackEntries.operations.wait", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/feedbackEntries/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to wait on.", "location": "path", "type": "string" }, "timeout": { "type": "string", "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query" } } }, "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.reasoningEngines.feedbackEntries.operations.delete", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/feedbackEntries/[^/]+/operations/[^/]+$" } }, "httpMethod": "DELETE", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "cancel": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations/{operationsId}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/feedbackEntries/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation resource to be cancelled.", "required": true } }, "httpMethod": "POST", "parameterOrder": [ "name" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "id": "aiplatform.projects.locations.reasoningEngines.feedbackEntries.operations.cancel", "path": "v1beta1/{+name}:cancel" }, "get": { "id": "aiplatform.projects.locations.reasoningEngines.feedbackEntries.operations.get", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations/{operationsId}", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/feedbackEntries/[^/]+/operations/[^/]+$", "description": "The name of the operation resource.", "location": "path" } }, "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" } } } } } }, "sandboxEnvironments": { "resources": { "operations": { "methods": { "get": { "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "required": true, "description": "The name of the operation resource.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.get", "parameterOrder": [ "name" ] }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "type": "string", "description": "The name of the operation resource to be deleted.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$" } }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ] }, "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.cancel", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be cancelled.", "type": "string", "required": true } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "path": "v1beta1/{+name}:cancel" }, "wait": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:wait", "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.wait", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to wait on.", "required": true }, "timeout": { "format": "google-duration", "type": "string", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." } }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:wait" }, "list": { "parameterOrder": [ "name" ], "path": "v1beta1/{+name}/operations", "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.list", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "httpMethod": "GET", "parameters": { "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "pageSize": { "format": "int32", "description": "The standard list page size.", "location": "query", "type": "integer" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "description": "The name of the operation's parent resource.", "location": "path", "type": "string", "required": true }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } } } } } }, "methods": { "execute": { "description": "Executes using a sandbox environment.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:execute", "response": { "$ref": "GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentResponse" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$" } }, "path": "v1beta1/{+name}:execute", "httpMethod": "POST", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.execute" }, "create": { "description": "Creates a SandboxEnvironment in a given reasoning engine.", "request": { "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.create", "path": "v1beta1/{+parent}/sandboxEnvironments", "parameterOrder": [ "parent" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "location": "path", "description": "Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`." } } }, "resume": { "path": "v1beta1/{+name}:resume", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1ResumeSandboxEnvironmentRequest" }, "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Resumes the specific SandboxEnvironment.", "parameters": { "name": { "type": "string", "required": true, "description": "Required. The resource name of the sandbox environment to resume. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$" } }, "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.resume", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:resume" }, "authorizeAccess": { "httpMethod": "POST", "response": { "$ref": "GoogleCloudAiplatformV1beta1AuthorizeSandboxEnvironmentAccessResponse" }, "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "location": "path", "description": "Required. The resource name of the sandbox environment to authorize access to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`" } }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:authorizeAccess", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:authorizeAccess", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.authorizeAccess", "description": "Checks whether the caller is authorized to access the sandbox environment. Authorization is performed entirely by the API infrastructure from the `method_policy` below; the handler is a no-op. A successful response means the caller holds `sandboxEnvironments.execute` on the named sandbox. Used by the sandbox data-plane proxy, which forwards the caller's credential and proxies traffic only on success.", "request": { "$ref": "GoogleCloudAiplatformV1beta1AuthorizeSandboxEnvironmentAccessRequest" } }, "delete": { "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Deletes the specific SandboxEnvironment.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.delete", "parameters": { "name": { "required": true, "description": "Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "type": "string" } }, "httpMethod": "DELETE" }, "list": { "response": { "$ref": "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentsResponse" }, "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", "path": "v1beta1/{+parent}/sandboxEnvironments", "parameters": { "pageSize": { "format": "int32", "type": "integer", "description": "Optional. The maximum number of SandboxEnvironments to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironments will be returned.", "location": "query" }, "parent": { "required": true, "type": "string", "location": "path", "description": "Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$" }, "filter": { "type": "string", "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", "location": "query" }, "pageToken": { "description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" } }, "description": "Lists SandboxEnvironments in a given reasoning engine.", "parameterOrder": [ "parent" ], "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "pause": { "description": "Pauses the specific SandboxEnvironment.", "path": "v1beta1/{+name}:pause", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1PauseSandboxEnvironmentRequest" }, "httpMethod": "POST", "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.pause", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "description": "Required. The resource name of the sandbox environment to pause. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:pause" }, "snapshot": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "description": "Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.", "request": { "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentSnapshot" }, "parameters": { "name": { "description": "Required. The resource name of the sandbox environment to snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`.", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "required": true, "type": "string", "location": "path" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:snapshot", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:snapshot", "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.snapshot" }, "get": { "path": "v1beta1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name of the sandbox environment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", "required": true } }, "httpMethod": "GET", "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.get", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironment" }, "description": "Gets details of the specific SandboxEnvironment.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "bidiExecute": { "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.bidiExecute", "description": "Executes using a sandbox environment with bidirectional streaming.", "parameterOrder": [ "name" ], "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1BidiExecuteSandboxEnvironmentRequest" }, "parameters": { "name": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1BidiExecuteSandboxEnvironmentResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:bidiExecute", "path": "v1beta1/{+name}:bidiExecute", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "a2a": { "methods": { "tasks": { "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "id": "aiplatform.projects.locations.reasoningEngines.a2a.tasks", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name", "a2aEndpoint" ], "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/tasks", "parameters": { "a2aEndpoint": { "pattern": "^tasks$", "location": "path", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "type": "string", "required": true }, "name": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`" }, "historyLength": { "type": "string", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "location": "query" } }, "response": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}" }, "card": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/card", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "id": "aiplatform.projects.locations.reasoningEngines.a2a.card", "response": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "parameters": { "a2aEndpoint": { "location": "path", "required": true, "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "pattern": "^card$", "type": "string" }, "historyLength": { "location": "query", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "type": "string" }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "type": "string", "required": true, "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`" } }, "httpMethod": "GET", "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "parameterOrder": [ "name", "a2aEndpoint" ] }, "extendedAgentCard": { "parameters": { "historyLength": { "type": "string", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "location": "query" }, "a2aEndpoint": { "pattern": "^extendedAgentCard$", "required": true, "type": "string", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "location": "path" }, "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "location": "path", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string" } }, "parameterOrder": [ "name", "a2aEndpoint" ], "id": "aiplatform.projects.locations.reasoningEngines.a2a.extendedAgentCard", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/extendedAgentCard", "response": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "description": "Get request for reasoning engine instance via the A2A get protocol apis." } }, "resources": { "v1": { "resources": { "tasks": { "methods": { "pushNotificationConfigs": { "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "parameterOrder": [ "name", "a2aEndpoint" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs", "httpMethod": "GET", "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "parameters": { "a2aEndpoint": { "pattern": "^v1/tasks/[^/]+/pushNotificationConfigs$", "required": true, "type": "string", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "location": "path" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "location": "path", "type": "string", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true }, "historyLength": { "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "type": "string", "location": "query" } } }, "a2aGetReasoningEngine": { "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.a2aGetReasoningEngine", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "httpMethod": "GET", "parameters": { "a2aEndpoint": { "type": "string", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "pattern": "^v1/tasks/[^/]+$", "location": "path", "required": true }, "name": { "required": true, "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$" }, "historyLength": { "location": "query", "type": "string", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned." } }, "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "parameterOrder": [ "name", "a2aEndpoint" ], "description": "Get request for reasoning engine instance via the A2A get protocol apis." }, "subscribe": { "httpMethod": "GET", "description": "Stream get request for reasoning engine instance via the A2A stream get protocol apis.", "parameters": { "a2aEndpoint": { "type": "string", "location": "path", "pattern": "^v1/tasks/[^/]+$", "required": true, "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`." }, "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$" } }, "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.subscribe", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name", "a2aEndpoint" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:subscribe", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe", "response": { "$ref": "GoogleApiHttpBody" } }, "cancel": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:cancel", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel", "response": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "request": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "parameterOrder": [ "name", "a2aEndpoint" ], "parameters": { "a2aEndpoint": { "required": true, "type": "string", "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", "location": "path", "pattern": "^v1/tasks/[^/]+$" }, "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$" } }, "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.cancel" } }, "resources": { "pushNotificationConfigs": { "methods": { "a2aGetReasoningEngine": { "parameters": { "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "location": "path" }, "a2aEndpoint": { "pattern": "^v1/tasks/[^/]+/pushNotificationConfigs/[^/]+$", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "location": "path", "required": true, "type": "string" }, "historyLength": { "location": "query", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "type": "string" } }, "httpMethod": "GET", "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs.a2aGetReasoningEngine", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", "parameterOrder": [ "name", "a2aEndpoint" ], "response": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}" } } } } }, "message": { "methods": { "send": { "httpMethod": "POST", "parameters": { "a2aEndpoint": { "location": "path", "type": "string", "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", "required": true, "pattern": "^v1/message$" }, "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "location": "path", "type": "string" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:send", "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.message.send", "request": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:send", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name", "a2aEndpoint" ] }, "stream": { "request": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "parameters": { "a2aEndpoint": { "required": true, "type": "string", "description": "Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.", "location": "path", "pattern": "^v1/message$" }, "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "location": "path", "type": "string", "required": true } }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Streams queries using a reasoning engine instance via the A2A streaming protocol apis.", "parameterOrder": [ "name", "a2aEndpoint" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:stream", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:stream", "response": { "$ref": "GoogleApiHttpBody" }, "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.message.stream" } } } }, "methods": { "extendedAgentCard": { "parameters": { "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string", "location": "path" }, "a2aEndpoint": { "location": "path", "type": "string", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "required": true, "pattern": "^v1/extendedAgentCard$" }, "historyLength": { "location": "query", "type": "string", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name", "a2aEndpoint" ], "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/extendedAgentCard", "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.extendedAgentCard", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "card": { "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "parameterOrder": [ "name", "a2aEndpoint" ], "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.card", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/card", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "a2aEndpoint": { "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "location": "path", "type": "string", "required": true, "pattern": "^v1/card$" }, "historyLength": { "type": "string", "location": "query", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned." }, "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string" } } }, "tasks": { "parameterOrder": [ "name", "a2aEndpoint" ], "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks", "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "historyLength": { "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "type": "string", "location": "query" }, "a2aEndpoint": { "type": "string", "pattern": "^v1/tasks$", "required": true, "location": "path", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`" }, "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "location": "path", "required": true, "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "httpMethod": "GET", "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } } }, "tasks": { "methods": { "subscribe": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.reasoningEngines.a2a.tasks.subscribe", "httpMethod": "GET", "parameterOrder": [ "name", "a2aEndpoint" ], "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "location": "path", "required": true, "description": "Required. The full resource path of the reasoning engine, captured from the URL." }, "a2aEndpoint": { "type": "string", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.", "location": "path", "required": true, "pattern": "^tasks/[^/]+$" } }, "description": "Stream get request for reasoning engine instance via the A2A stream get protocol apis.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}:subscribe", "response": { "$ref": "GoogleApiHttpBody" }, "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe" }, "a2aGetReasoningEngine": { "parameterOrder": [ "name", "a2aEndpoint" ], "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "id": "aiplatform.projects.locations.reasoningEngines.a2a.tasks.a2aGetReasoningEngine", "parameters": { "historyLength": { "location": "query", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "type": "string" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true, "type": "string", "location": "path" }, "a2aEndpoint": { "location": "path", "pattern": "^tasks/[^/]+$", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "required": true, "type": "string" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}", "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "httpMethod": "GET", "response": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "pushNotificationConfigs": { "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "response": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "id": "aiplatform.projects.locations.reasoningEngines.a2a.tasks.pushNotificationConfigs", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}/pushNotificationConfigs", "parameters": { "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$" }, "historyLength": { "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "location": "query", "type": "string" }, "a2aEndpoint": { "pattern": "^tasks/[^/]+/pushNotificationConfigs$", "required": true, "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "type": "string", "location": "path" } }, "parameterOrder": [ "name", "a2aEndpoint" ], "httpMethod": "GET" }, "cancel": { "request": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.reasoningEngines.a2a.tasks.cancel", "parameters": { "a2aEndpoint": { "pattern": "^tasks/[^/]+$", "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", "required": true, "type": "string", "location": "path" }, "name": { "location": "path", "type": "string", "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$" } }, "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", "parameterOrder": [ "name", "a2aEndpoint" ], "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}:cancel", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel", "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "resources": { "pushNotificationConfigs": { "methods": { "a2aGetReasoningEngine": { "parameterOrder": [ "name", "a2aEndpoint" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", "response": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "id": "aiplatform.projects.locations.reasoningEngines.a2a.tasks.pushNotificationConfigs.a2aGetReasoningEngine", "httpMethod": "GET", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "parameters": { "historyLength": { "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "location": "query", "type": "string" }, "name": { "location": "path", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$" }, "a2aEndpoint": { "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "pattern": "^tasks/[^/]+/pushNotificationConfigs/[^/]+$", "required": true, "type": "string", "location": "path" } } } } } } }, "message": { "methods": { "stream": { "id": "aiplatform.projects.locations.reasoningEngines.a2a.message.stream", "description": "Streams queries using a reasoning engine instance via the A2A streaming protocol apis.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/message:stream", "request": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleApiHttpBody" }, "httpMethod": "POST", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The full resource path of the reasoning engine, captured from the URL." }, "a2aEndpoint": { "required": true, "type": "string", "location": "path", "description": "Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.", "pattern": "^message$" } }, "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:stream", "parameterOrder": [ "name", "a2aEndpoint" ] }, "send": { "response": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "request": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/message:send", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "location": "path", "type": "string", "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$" }, "a2aEndpoint": { "required": true, "pattern": "^message$", "location": "path", "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", "type": "string" } }, "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", "httpMethod": "POST", "id": "aiplatform.projects.locations.reasoningEngines.a2a.message.send", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:send", "parameterOrder": [ "name", "a2aEndpoint" ] } } } } }, "sandboxEnvironmentTemplates": { "resources": { "operations": { "methods": { "cancel": { "path": "v1beta1/{+name}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}:cancel", "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation resource to be cancelled.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.cancel", "parameterOrder": [ "name" ], "httpMethod": "POST" }, "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameters": { "name": { "location": "path", "required": true, "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$", "type": "string" }, "pageSize": { "location": "query", "format": "int32", "description": "The standard list page size.", "type": "integer" }, "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." } }, "httpMethod": "GET", "path": "v1beta1/{+name}/operations", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.list", "parameterOrder": [ "name" ] }, "get": { "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource.", "type": "string", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.get" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}", "httpMethod": "DELETE", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.delete", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation resource to be deleted.", "required": true } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}" }, "wait": { "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.wait", "parameters": { "name": { "location": "path", "required": true, "description": "The name of the operation resource to wait on.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$" }, "timeout": { "location": "query", "type": "string", "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:wait", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done." } } } }, "methods": { "create": { "description": "Creates a SandboxEnvironmentTemplate in a given reasoning engine.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.create", "path": "v1beta1/{+parent}/sandboxEnvironmentTemplates", "request": { "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplate" }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "parameters": { "parent": { "type": "string", "description": "Required. The resource name of the reasoning engine to create the SandboxEnvironmentTemplate in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "location": "path" } } }, "delete": { "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.delete", "parameters": { "name": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$", "description": "Required. The resource name of the SandboxEnvironmentTemplate to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`" } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Deletes the specific SandboxEnvironmentTemplate.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "response": { "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplate" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.get", "description": "Gets details of the specific SandboxEnvironmentTemplate.", "httpMethod": "GET", "path": "v1beta1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$", "location": "path", "description": "Required. The resource name of the sandbox environment template. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`", "type": "string", "required": true } } }, "list": { "path": "v1beta1/{+parent}/sandboxEnvironmentTemplates", "parameters": { "parent": { "location": "path", "description": "Required. The resource name of the reasoning engine to list sandbox environment templates from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$" }, "filter": { "type": "string", "location": "query", "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160)." }, "pageToken": { "description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironmentTemplates` call. Provide this to retrieve the subsequent page.", "type": "string", "location": "query" }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "Optional. The maximum number of SandboxEnvironmentTemplates to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentTemplates will be returned." } }, "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.list", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentTemplatesResponse" }, "description": "Lists SandboxEnvironmentTemplates in a given reasoning engine.", "parameterOrder": [ "parent" ] } } }, "memories": { "methods": { "list": { "description": "List Memories.", "path": "v1beta1/{+parent}/memories", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1ListMemoriesResponse" }, "parameters": { "orderBy": { "type": "string", "location": "query", "description": "Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`" }, "pageToken": { "location": "query", "description": "Optional. The standard list page token.", "type": "string" }, "parent": { "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "description": "Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`" }, "pageSize": { "location": "query", "description": "Optional. The standard list page size.", "format": "int32", "type": "integer" }, "filter": { "location": "query", "type": "string", "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `scope` (as a JSON string with equality match only) * `topics` (i.e. `topics.custom_memory_topic_label: \"example topic\" OR topics.managed_memory_topic: USER_PREFERENCES`)" } }, "id": "aiplatform.projects.locations.reasoningEngines.memories.list", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories", "httpMethod": "GET" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Delete a Memory.", "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$", "location": "path", "description": "Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "type": "string", "required": true } }, "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.reasoningEngines.memories.delete", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}" }, "purge": { "httpMethod": "POST", "path": "v1beta1/{+parent}/memories:purge", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "required": true, "description": "Required. The resource name of the ReasoningEngine to purge memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories:purge", "request": { "$ref": "GoogleCloudAiplatformV1beta1PurgeMemoriesRequest" }, "id": "aiplatform.projects.locations.reasoningEngines.memories.purge", "description": "Purge memories.", "parameterOrder": [ "parent" ] }, "create": { "id": "aiplatform.projects.locations.reasoningEngines.memories.create", "parameters": { "memoryId": { "description": "Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number.", "type": "string", "location": "query" }, "parent": { "description": "Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "location": "path", "type": "string", "required": true } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1Memory" }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+parent}/memories", "description": "Create a Memory.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "ingestEvents": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "description": "Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string" } }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories:ingestEvents", "path": "v1beta1/{+parent}/memories:ingestEvents", "parameterOrder": [ "parent" ], "id": "aiplatform.projects.locations.reasoningEngines.memories.ingestEvents", "description": "Ingests events for a Memory Bank.", "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1IngestEventsRequest" } }, "get": { "path": "v1beta1/{+name}", "parameters": { "name": { "required": true, "type": "string", "description": "Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$", "location": "path" } }, "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}", "id": "aiplatform.projects.locations.reasoningEngines.memories.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1Memory" }, "description": "Get a Memory.", "parameterOrder": [ "name" ] }, "patch": { "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}", "request": { "$ref": "GoogleCloudAiplatformV1beta1Memory" }, "description": "Update a Memory.", "path": "v1beta1/{+name}", "httpMethod": "PATCH", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "updateMask": { "description": "Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type`", "format": "google-fieldmask", "location": "query", "type": "string" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$", "required": true, "description": "Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "type": "string", "location": "path" } }, "id": "aiplatform.projects.locations.reasoningEngines.memories.patch" }, "retrieve": { "response": { "$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesResponse" }, "description": "Retrieve memories.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories:retrieve", "path": "v1beta1/{+parent}/memories:retrieve", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.reasoningEngines.memories.retrieve", "parameters": { "parent": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "description": "Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequest" }, "httpMethod": "POST" }, "rollback": { "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}:rollback", "request": { "$ref": "GoogleCloudAiplatformV1beta1RollbackMemoryRequest" }, "id": "aiplatform.projects.locations.reasoningEngines.memories.rollback", "parameters": { "name": { "description": "Required. The resource name of the Memory to rollback. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$", "location": "path" } }, "httpMethod": "POST", "description": "Rollback Memory to a specific revision.", "path": "v1beta1/{+name}:rollback", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "retrieveProfiles": { "id": "aiplatform.projects.locations.reasoningEngines.memories.retrieveProfiles", "request": { "$ref": "GoogleCloudAiplatformV1beta1RetrieveProfilesRequest" }, "parameterOrder": [ "parent" ], "description": "Retrieves profiles.", "path": "v1beta1/{+parent}/memories:retrieveProfiles", "response": { "$ref": "GoogleCloudAiplatformV1beta1RetrieveProfilesResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories:retrieveProfiles", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "description": "Required. The resource name of the ReasoningEngine to retrieve profiles from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$" } } }, "generate": { "path": "v1beta1/{+parent}/memories:generate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Generate memories.", "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequest" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "type": "string", "description": "Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", "required": true } }, "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.reasoningEngines.memories.generate", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories:generate", "parameterOrder": [ "parent" ] } }, "resources": { "revisions": { "methods": { "get": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/revisions/{revisionsId}", "response": { "$ref": "GoogleCloudAiplatformV1beta1MemoryRevision" }, "id": "aiplatform.projects.locations.reasoningEngines.memories.revisions.get", "description": "Get a Memory Revision.", "httpMethod": "GET", "parameters": { "name": { "required": true, "description": "Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{revision}`", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/revisions/[^/]+$", "location": "path", "type": "string" } }, "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "list": { "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The resource name of the Memory to list revisions for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`" }, "filter": { "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels`", "type": "string", "location": "query" }, "pageToken": { "description": "Optional. The standard list page token.", "type": "string", "location": "query" }, "pageSize": { "location": "query", "format": "int32", "description": "Optional. The standard list page size.", "type": "integer" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/revisions", "description": "List Memory Revisions for a Memory.", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListMemoryRevisionsResponse" }, "id": "aiplatform.projects.locations.reasoningEngines.memories.revisions.list", "path": "v1beta1/{+parent}/revisions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "operations": { "methods": { "wait": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:wait", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string", "description": "The name of the operation resource to wait on.", "location": "path" }, "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "format": "google-duration", "location": "query" } }, "httpMethod": "POST", "id": "aiplatform.projects.locations.reasoningEngines.memories.operations.wait", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}:wait", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done." }, "get": { "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "GET", "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "The name of the operation resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", "type": "string", "required": true } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}", "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "id": "aiplatform.projects.locations.reasoningEngines.memories.operations.get" }, "list": { "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "description": "The name of the operation's parent resource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$", "type": "string" }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "The standard list page size." }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "httpMethod": "GET", "path": "v1beta1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "id": "aiplatform.projects.locations.reasoningEngines.memories.operations.list", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations" }, "delete": { "id": "aiplatform.projects.locations.reasoningEngines.memories.operations.delete", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation resource to be deleted." } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be cancelled." } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.reasoningEngines.memories.operations.cancel", "httpMethod": "POST", "path": "v1beta1/{+name}:cancel", "parameterOrder": [ "name" ] } } } } }, "a2aTasks": { "methods": { "delete": { "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2aTasks/{a2aTasksId}", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "Required. The resource name of the A2aTask to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` or `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTasks/{a2a_task}`", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/a2aTasks/[^/]+$" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.projects.locations.reasoningEngines.a2aTasks.delete", "httpMethod": "DELETE", "description": "Deletes an A2aTask.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "parameterOrder": [ "parent" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2aTasks", "request": { "$ref": "GoogleCloudAiplatformV1beta1A2aTask" }, "response": { "$ref": "GoogleCloudAiplatformV1beta1A2aTask" }, "httpMethod": "POST", "parameters": { "parent": { "location": "path", "required": true, "type": "string", "description": "Required. The resource name of the ReasoningEngine or TaskStore to create the A2aTask under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` or `projects/{project}/locations/{location}/taskStores/{task_store}`", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$" }, "a2aTaskId": { "description": "Required. User-defined ID of the A2aTask. This ID must be unique within the parent resource. It must be 1-63 characters, start with a lowercase letter or number, end with a lowercase letter or number, and only contain lowercase letters, numbers, and hyphens [AIP-122](https://google.aip.dev/122). Starting with a number is allowed for compatibility with the auto-generated UUID from A2A SDK.", "location": "query", "type": "string" } }, "id": "aiplatform.projects.locations.reasoningEngines.a2aTasks.create", "path": "v1beta1/{+parent}/a2aTasks", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates an A2aTask." }, "list": { "httpMethod": "GET", "parameters": { "pageToken": { "description": "Optional. The next_page_token value returned from a previous list ListA2aTasks call.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. If this field is omitted, the default ordering is `create_time` descending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time` Example: `create_time desc`.", "location": "query", "type": "string" }, "filter": { "location": "query", "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `context_id` * `state` Example: `context_id=\"abc\"`, `state=\"WORKING\"`.", "type": "string" }, "parent": { "description": "Required. The resource name of the ReasoningEngine or TaskStore to list the A2aTasks under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` or `projects/{project}/locations/{location}/taskStores/{task_store}`", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "location": "path" }, "pageSize": { "description": "Optional. The maximum number of tasks to return. The service may return fewer than this value. If unspecified, at most 10 tasks will be returned. The maximum value is 100; values above 100 will hit exception.", "format": "int32", "location": "query", "type": "integer" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "description": "Lists A2aTasks for a ReasoningEngine.", "id": "aiplatform.projects.locations.reasoningEngines.a2aTasks.list", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListA2aTasksResponse" }, "path": "v1beta1/{+parent}/a2aTasks", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2aTasks" }, "appendEvents": { "description": "Appends TaskEvents to an A2aTask.", "path": "v1beta1/{+name}:appendEvents", "request": { "$ref": "GoogleCloudAiplatformV1beta1AppendA2aTaskEventsRequest" }, "id": "aiplatform.projects.locations.reasoningEngines.a2aTasks.appendEvents", "parameters": { "name": { "type": "string", "description": "Required. The resource name of the A2aTask to append events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` or `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTasks/{a2a_task}`", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/a2aTasks/[^/]+$" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2aTasks/{a2aTasksId}:appendEvents", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1AppendA2aTaskEventsResponse" } }, "get": { "response": { "$ref": "GoogleCloudAiplatformV1beta1A2aTask" }, "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2aTasks/{a2aTasksId}", "httpMethod": "GET", "id": "aiplatform.projects.locations.reasoningEngines.a2aTasks.get", "description": "Gets an A2aTask.", "parameters": { "name": { "type": "string", "location": "path", "description": "Required. The resource name of the A2aTask. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` or `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTasks/{a2a_task}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/a2aTasks/[^/]+$" }, "view": { "type": "string", "description": "Optional. The view of the A2aTask to return.", "location": "query", "enum": [ "A2A_TASK_VIEW_UNSPECIFIED", "A2A_TASK_VIEW_BASIC", "A2A_TASK_VIEW_FULL" ], "enumDescriptions": [ "Task view unspecified.", "Task header only (status, metadata, timestamps)", "Full materialized state (artifacts + history)" ] } }, "parameterOrder": [ "name" ] } }, "resources": { "events": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "filter": { "description": "Optional. The standard list filter. Supported fields: * `create_time` range (i.e. `create_time\u003e=\"2025-01-31T11:30:00-04:00\"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160).", "type": "string", "location": "query" }, "pageSize": { "format": "int32", "location": "query", "description": "Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. The maximum value is 100; values above 100 will hit exception.", "type": "integer" }, "parent": { "required": true, "type": "string", "location": "path", "description": "Required. The resource name of the A2aTask to list the TaskEvents under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` or `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTasks/{a2a_task}`", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/a2aTasks/[^/]+$" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The next_page_token value returned from a previous list ListA2aTaskEvents call." }, "orderBy": { "type": "string", "location": "query", "description": "Optional. A comma-separated list of fields to order the results by. If this field is omitted, the results will be ordered by `event_sequence_number` in descending order. For each field, the default sort order is ascending. To specify descending order for a field, append a ` desc` suffix. For example: `create_time desc`. Supported fields: * `create_time` * `event_sequence_number`" } }, "description": "Lists TaskEvents for an A2aTask.", "httpMethod": "GET", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListA2aTaskEventsResponse" }, "path": "v1beta1/{+parent}/events", "parameterOrder": [ "parent" ], "id": "aiplatform.projects.locations.reasoningEngines.a2aTasks.events.list", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2aTasks/{a2aTasksId}/events" } } } } } } }, "semanticGovernancePolicies": { "resources": { "operations": { "methods": { "wait": { "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}:wait", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}:wait", "id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.wait", "httpMethod": "POST", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource to wait on.", "required": true }, "timeout": { "format": "google-duration", "type": "string", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." } }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "required": true } }, "httpMethod": "GET", "id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.get", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}" }, "list": { "parameterOrder": [ "name" ], "parameters": { "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "returnPartialSuccess": { "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query" }, "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+$", "location": "path", "description": "The name of the operation's parent resource.", "required": true } }, "httpMethod": "GET", "id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.list", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v1beta1/{+name}/operations", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations" }, "delete": { "httpMethod": "DELETE", "id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.delete", "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "type": "string" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "cancel": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "httpMethod": "POST", "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation resource to be cancelled.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$" } }, "path": "v1beta1/{+name}:cancel", "id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.cancel" } } } }, "methods": { "patch": { "parameterOrder": [ "name" ], "description": "Updates a SemanticGovernancePolicy.", "httpMethod": "PATCH", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}", "id": "aiplatform.projects.locations.semanticGovernancePolicies.patch", "parameters": { "updateMask": { "location": "query", "type": "string", "description": "Optional. `update_mask` is used to specify the fields to be overwritten in the SemanticGovernancePolicy resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the mask is not present, then all fields that are populated in the request message will be overwritten. Set the `update_mask` to `*` to override all fields.", "format": "google-fieldmask" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+$", "location": "path", "type": "string", "required": true, "description": "Identifier. Resource name of the SemanticGovernancePolicy." } }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "request": { "$ref": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicy" } }, "delete": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "description": "Required. The name of the SemanticGovernancePolicy resource to be deleted. Format: `projects/{project}/locations/{location}/semanticGovernancePolicies/{semantic_governance_policy}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+$", "required": true, "location": "path" }, "etag": { "type": "string", "location": "query", "description": "Optional. The etag of the SemanticGovernancePolicy. If an etag is provided and does not match the current etag of the SemanticGovernancePolicy, deletion will be blocked and an ABORTED error will be returned." } }, "path": "v1beta1/{+name}", "httpMethod": "DELETE", "description": "Deletes a SemanticGovernancePolicy.", "id": "aiplatform.projects.locations.semanticGovernancePolicies.delete" }, "create": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies", "id": "aiplatform.projects.locations.semanticGovernancePolicies.create", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Creates a SemanticGovernancePolicy.", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "description": "Required. The resource name of the Location into which to create the SemanticGovernancePolicy. Format: `projects/{project}/locations/{location}`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "type": "string", "required": true }, "semanticGovernancePolicyId": { "location": "query", "description": "Required. The ID to use for the SemanticGovernancePolicy, which will become the final component of the SemanticGovernancePolicy's resource name. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character cannot be a number or hyphen. The last character must be a letter or a number.", "type": "string" } }, "httpMethod": "POST", "path": "v1beta1/{+parent}/semanticGovernancePolicies", "request": { "$ref": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicy" } }, "list": { "parameterOrder": [ "parent" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists SemanticGovernancePolicies in a given location.", "path": "v1beta1/{+parent}/semanticGovernancePolicies", "httpMethod": "GET", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListSemanticGovernancePoliciesResponse" }, "parameters": { "parent": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The resource name of the Location from which to list the SemanticGovernancePolicies. Format: `projects/{project}/locations/{location}`", "type": "string" }, "pageSize": { "description": "Optional. The list page size. If zero, a default page size of 10 is used.", "type": "integer", "location": "query", "format": "int32" }, "pageToken": { "type": "string", "location": "query", "description": "Optional. The standard list page token." } }, "id": "aiplatform.projects.locations.semanticGovernancePolicies.list" }, "get": { "response": { "$ref": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicy" }, "id": "aiplatform.projects.locations.semanticGovernancePolicies.get", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}", "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the SemanticGovernancePolicy resource. Format: `projects/{project}/locations/{location}/semanticGovernancePolicies/{semantic_governance_policy}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+$" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets a SemanticGovernancePolicy.", "parameterOrder": [ "name" ] } } }, "indexEndpoints": { "methods": { "delete": { "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.indexEndpoints.delete", "description": "Deletes an IndexEndpoint.", "httpMethod": "DELETE", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}", "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", "required": true, "description": "Required. The name of the IndexEndpoint resource to be deleted. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ] }, "undeployIndex": { "httpMethod": "POST", "parameters": { "indexEndpoint": { "description": "Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", "type": "string" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1UndeployIndexRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.indexEndpoints.undeployIndex", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.", "parameterOrder": [ "indexEndpoint" ], "path": "v1beta1/{+indexEndpoint}:undeployIndex", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:undeployIndex" }, "mutateDeployedIndex": { "request": { "$ref": "GoogleCloudAiplatformV1beta1DeployedIndex" }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:mutateDeployedIndex", "parameters": { "indexEndpoint": { "description": "Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$" }, "updateMask": { "description": "Optional. The update mask applies to the resource. The supported paths are `automatic_resources`, `dedicated_resources`, `enable_access_logging` and `deployed_index_auth_config`. When omitted, the service will perform a full update of all fields. See google.protobuf.FieldMask.", "format": "google-fieldmask", "location": "query", "type": "string" } }, "id": "aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+indexEndpoint}:mutateDeployedIndex", "description": "Update an existing DeployedIndex under an IndexEndpoint.", "parameterOrder": [ "indexEndpoint" ] }, "readIndexDatapoints": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:readIndexDatapoints", "parameterOrder": [ "indexEndpoint" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1ReadIndexDatapointsResponse" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1ReadIndexDatapointsRequest" }, "path": "v1beta1/{+indexEndpoint}:readIndexDatapoints", "id": "aiplatform.projects.locations.indexEndpoints.readIndexDatapoints", "description": "Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch.", "parameters": { "indexEndpoint": { "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", "description": "Required. The name of the index endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`" } }, "httpMethod": "POST" }, "patch": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}", "request": { "$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "parameters": { "updateMask": { "location": "query", "format": "google-fieldmask", "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", "type": "string" }, "name": { "type": "string", "location": "path", "description": "Output only. The resource name of the IndexEndpoint.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$" } }, "id": "aiplatform.projects.locations.indexEndpoints.patch", "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint" }, "parameterOrder": [ "name" ], "description": "Updates an IndexEndpoint." }, "create": { "parameters": { "parent": { "required": true, "description": "Required. The resource name of the Location to create the IndexEndpoint in. Format: `projects/{project}/locations/{location}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint" }, "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/indexEndpoints", "description": "Creates an IndexEndpoint.", "id": "aiplatform.projects.locations.indexEndpoints.create", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints" }, "findNeighbors": { "httpMethod": "POST", "path": "v1beta1/{+indexEndpoint}:findNeighbors", "parameters": { "indexEndpoint": { "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", "location": "path", "description": "Required. The name of the index endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", "type": "string", "required": true } }, "id": "aiplatform.projects.locations.indexEndpoints.findNeighbors", "parameterOrder": [ "indexEndpoint" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:findNeighbors", "response": { "$ref": "GoogleCloudAiplatformV1beta1FindNeighborsResponse" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1FindNeighborsRequest" }, "description": "Finds the nearest neighbors of each vector within the request.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "description": "Gets an IndexEndpoint.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The name of the IndexEndpoint resource. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.indexEndpoints.get", "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "response": { "$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}" }, "list": { "id": "aiplatform.projects.locations.indexEndpoints.list", "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/indexEndpoints", "parameters": { "filter": { "location": "query", "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `index_endpoint` supports = and !=. `index_endpoint` represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename. * `display_name` supports =, != and regex() (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* or labels:key - key existence A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `index_endpoint=\"1\"` * `display_name=\"myDisplayName\"` * `regex(display_name, \"^A\") -\u003e The display name starts with an A. * `labels.myKey=\"myValue\"`", "type": "string" }, "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The resource name of the Location from which to list the IndexEndpoints. Format: `projects/{project}/locations/{location}`", "location": "path", "required": true }, "pageSize": { "description": "Optional. The standard list page size.", "location": "query", "format": "int32", "type": "integer" }, "readMask": { "description": "Optional. Mask specifying which fields to read.", "location": "query", "format": "google-fieldmask", "type": "string" }, "pageToken": { "location": "query", "description": "Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call.", "type": "string" } }, "description": "Lists IndexEndpoints in a Location.", "httpMethod": "GET", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListIndexEndpointsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints" }, "deployIndex": { "parameterOrder": [ "indexEndpoint" ], "id": "aiplatform.projects.locations.indexEndpoints.deployIndex", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:deployIndex", "path": "v1beta1/{+indexEndpoint}:deployIndex", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "indexEndpoint": { "location": "path", "description": "Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", "type": "string", "required": true } }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1DeployIndexRequest" }, "description": "Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "operations": { "methods": { "delete": { "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted." } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}", "id": "aiplatform.projects.locations.indexEndpoints.operations.delete", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." }, "list": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations", "parameterOrder": [ "name" ], "parameters": { "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "The standard list page size." }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", "required": true, "type": "string", "description": "The name of the operation's parent resource.", "location": "path" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } }, "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.indexEndpoints.operations.list", "path": "v1beta1/{+name}/operations" }, "wait": { "httpMethod": "POST", "parameters": { "name": { "required": true, "description": "The name of the operation resource to wait on.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$" }, "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration", "type": "string", "location": "query" } }, "path": "v1beta1/{+name}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait", "id": "aiplatform.projects.locations.indexEndpoints.operations.wait", "parameterOrder": [ "name" ] }, "get": { "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.indexEndpoints.operations.get", "httpMethod": "GET", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource.", "required": true } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "cancel": { "path": "v1beta1/{+name}:cancel", "httpMethod": "POST", "id": "aiplatform.projects.locations.indexEndpoints.operations.cancel", "parameters": { "name": { "location": "path", "type": "string", "description": "The name of the operation resource to be cancelled.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." } } } } }, "notebookRuntimes": { "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.projects.locations.notebookRuntimes.operations.cancel", "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be cancelled." } }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:cancel" }, "list": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.notebookRuntimes.operations.list", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation's parent resource.", "required": true }, "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." } }, "response": { "$ref": "GoogleLongrunningListOperationsResponse" } }, "wait": { "httpMethod": "POST", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.notebookRuntimes.operations.wait", "parameters": { "timeout": { "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "format": "google-duration" }, "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to wait on.", "required": true } }, "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done." }, "get": { "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.notebookRuntimes.operations.get", "path": "v1beta1/{+name}", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.notebookRuntimes.operations.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource to be deleted.", "location": "path", "required": true } }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "httpMethod": "DELETE", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}" } } } }, "methods": { "delete": { "description": "Deletes a NotebookRuntime.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.notebookRuntimes.delete", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", "location": "path", "type": "string", "required": true, "description": "Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner." } }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "DELETE" }, "generateAccessToken": { "parameters": { "name": { "required": true, "description": "Required. The name of the resource requesting the OAuth2 token. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}` `projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_job}`", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$" } }, "id": "aiplatform.projects.locations.notebookRuntimes.generateAccessToken", "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:generateAccessToken", "response": { "$ref": "GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Internal only: Called from Compute Engine instance to obtain EUC for owner Anonymous access: authenticates caller using VM identity JWT. Design doc: go/colab-on-vertex-euc-dd", "path": "v1beta1/{+name}:generateAccessToken", "request": { "$ref": "GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest" } }, "get": { "parameters": { "name": { "required": true, "description": "Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", "type": "string" } }, "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}", "id": "aiplatform.projects.locations.notebookRuntimes.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1NotebookRuntime" }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "description": "Gets a NotebookRuntime." }, "start": { "path": "v1beta1/{+name}:start", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:start", "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$" } }, "description": "Starts a NotebookRuntime.", "request": { "$ref": "GoogleCloudAiplatformV1beta1StartNotebookRuntimeRequest" }, "httpMethod": "POST", "id": "aiplatform.projects.locations.notebookRuntimes.start", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "stop": { "httpMethod": "POST", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", "required": true, "description": "Required. The name of the NotebookRuntime resource to be stopped. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.", "type": "string", "location": "path" } }, "id": "aiplatform.projects.locations.notebookRuntimes.stop", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1StopNotebookRuntimeRequest" }, "path": "v1beta1/{+name}:stop", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:stop", "parameterOrder": [ "name" ], "description": "Stops a NotebookRuntime.", "response": { "$ref": "GoogleLongrunningOperation" } }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes", "id": "aiplatform.projects.locations.notebookRuntimes.list", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListNotebookRuntimesResponse" }, "path": "v1beta1/{+parent}/notebookRuntimes", "parameters": { "filter": { "location": "query", "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntime=\"notebookRuntime123\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"` * `notebookRuntimeTemplate=\"notebookRuntimeTemplate321\"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser=\"test@google.com\"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4`", "type": "string" }, "pageToken": { "location": "query", "description": "Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.", "type": "string" }, "parent": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project}/locations/{location}`" }, "pageSize": { "format": "int32", "description": "Optional. The standard list page size.", "location": "query", "type": "integer" }, "orderBy": { "type": "string", "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", "location": "query" }, "readMask": { "location": "query", "description": "Optional. Mask specifying which fields to read.", "format": "google-fieldmask", "type": "string" } }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "description": "Lists NotebookRuntimes in a Location." }, "reportEvent": { "path": "v1beta1/{+name}:reportEvent", "id": "aiplatform.projects.locations.notebookRuntimes.reportEvent", "request": { "$ref": "GoogleCloudAiplatformV1beta1ReportRuntimeEventRequest" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1ReportRuntimeEventResponse" }, "description": "", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", "required": true, "location": "path", "description": "Required. The name of the NotebookRuntime resource. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}`" } }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:reportEvent" }, "upgrade": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:upgrade", "id": "aiplatform.projects.locations.notebookRuntimes.upgrade", "request": { "$ref": "GoogleCloudAiplatformV1beta1UpgradeNotebookRuntimeRequest" }, "description": "Upgrades a NotebookRuntime.", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}:upgrade", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", "required": true, "description": "Required. The name of the NotebookRuntime resource to be upgrade. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.", "type": "string", "location": "path" } } }, "assign": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+parent}/notebookRuntimes:assign", "description": "Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.", "parameters": { "parent": { "location": "path", "type": "string", "description": "Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project}/locations/{location}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1AssignNotebookRuntimeRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes:assign", "id": "aiplatform.projects.locations.notebookRuntimes.assign" } } }, "publishers": { "resources": { "models": { "methods": { "fetchPredictOperation": { "path": "v1beta1/{+endpoint}:fetchPredictOperation", "id": "aiplatform.projects.locations.publishers.models.fetchPredictOperation", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation", "httpMethod": "POST", "parameterOrder": [ "endpoint" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1FetchPredictOperationRequest" }, "parameters": { "endpoint": { "description": "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}`", "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "required": true, "type": "string", "location": "path" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Fetch an asynchronous online prediction operation." }, "serverStreamingPredict": { "id": "aiplatform.projects.locations.publishers.models.serverStreamingPredict", "parameterOrder": [ "endpoint" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1StreamingPredictRequest" }, "description": "Perform a server-side streaming online prediction request for Vertex LLM streaming.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "path": "v1beta1/{+endpoint}:serverStreamingPredict", "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:serverStreamingPredict", "parameters": { "endpoint": { "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1StreamingPredictResponse" } }, "streamRawPredict": { "response": { "$ref": "GoogleApiHttpBody" }, "path": "v1beta1/{+endpoint}:streamRawPredict", "parameterOrder": [ "endpoint" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamRawPredict", "request": { "$ref": "GoogleCloudAiplatformV1beta1StreamRawPredictRequest" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "id": "aiplatform.projects.locations.publishers.models.streamRawPredict", "parameters": { "endpoint": { "required": true, "type": "string", "location": "path", "description": "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}`", "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$" } }, "httpMethod": "POST", "description": "Perform a streaming online prediction with an arbitrary HTTP payload." }, "setPublisherModelConfig": { "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:setPublisherModelConfig", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "required": true, "type": "string", "description": "Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.", "location": "path" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1SetPublisherModelConfigRequest" }, "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.publishers.models.setPublisherModelConfig", "path": "v1beta1/{+name}:setPublisherModelConfig", "description": "Sets (creates or updates) configs of publisher models. For example, sets the request/response logging config." }, "streamGenerateContent": { "path": "v1beta1/{+model}:streamGenerateContent", "parameters": { "model": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "description": "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": true } }, "parameterOrder": [ "model" ], "httpMethod": "POST", "description": "Generate content with multimodal inputs with streaming support.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent", "request": { "$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" }, "id": "aiplatform.projects.locations.publishers.models.streamGenerateContent", "response": { "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" } }, "computeTokens": { "parameterOrder": [ "endpoint" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1ComputeTokensRequest" }, "id": "aiplatform.projects.locations.publishers.models.computeTokens", "parameters": { "endpoint": { "description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "required": true } }, "path": "v1beta1/{+endpoint}:computeTokens", "httpMethod": "POST", "description": "Return a list of tokens based on the input text.", "response": { "$ref": "GoogleCloudAiplatformV1beta1ComputeTokensResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:computeTokens", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "generateContent": { "request": { "$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:generateContent", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "parameterOrder": [ "model" ], "description": "Generate content with multimodal inputs.", "parameters": { "model": { "description": "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}`", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "required": true } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" }, "httpMethod": "POST", "id": "aiplatform.projects.locations.publishers.models.generateContent", "path": "v1beta1/{+model}:generateContent" }, "export": { "request": { "$ref": "GoogleCloudAiplatformV1beta1ExportPublisherModelRequest" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "type": "string", "description": "Required. The Location to export the model weights from Format: `projects/{project}/locations/{location}`", "required": true }, "name": { "description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`", "required": true, "location": "path", "type": "string", "pattern": "^publishers/[^/]+/models/[^/]+$" } }, "description": "Exports a publisher model to a user provided Google Cloud Storage bucket.", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+parent}/{+name}:export", "id": "aiplatform.projects.locations.publishers.models.export", "parameterOrder": [ "parent", "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:export" }, "countTokens": { "request": { "$ref": "GoogleCloudAiplatformV1beta1CountTokensRequest" }, "parameters": { "endpoint": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "location": "path", "description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "type": "string" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1CountTokensResponse" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "httpMethod": "POST", "parameterOrder": [ "endpoint" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:countTokens", "description": "Perform a token counting.", "id": "aiplatform.projects.locations.publishers.models.countTokens", "path": "v1beta1/{+endpoint}:countTokens" }, "predict": { "httpMethod": "POST", "description": "", "request": { "$ref": "GoogleCloudAiplatformV1beta1PredictRequest" }, "parameters": { "endpoint": { "location": "path", "type": "string", "required": true, "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1PredictResponse" }, "id": "aiplatform.projects.locations.publishers.models.predict", "path": "v1beta1/{+endpoint}:predict", "parameterOrder": [ "endpoint" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predict" }, "fetchPublisherModelConfig": { "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelConfig" }, "description": "Fetches the configs of publisher models.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:fetchPublisherModelConfig", "id": "aiplatform.projects.locations.publishers.models.fetchPublisherModelConfig", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "required": true, "description": "Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.", "type": "string" } }, "httpMethod": "GET", "path": "v1beta1/{+name}:fetchPublisherModelConfig", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "rawPredict": { "description": "Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction.", "request": { "$ref": "GoogleCloudAiplatformV1beta1RawPredictRequest" }, "id": "aiplatform.projects.locations.publishers.models.rawPredict", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "path": "v1beta1/{+endpoint}:rawPredict", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:rawPredict", "httpMethod": "POST", "parameters": { "endpoint": { "required": true, "type": "string", "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "location": "path" } }, "response": { "$ref": "GoogleApiHttpBody" }, "parameterOrder": [ "endpoint" ] }, "getIamPolicy": { "parameterOrder": [ "resource" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:getIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "resource": { "required": true, "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$" }, "options.requestedPolicyVersion": { "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" } }, "httpMethod": "POST", "id": "aiplatform.projects.locations.publishers.models.getIamPolicy", "response": { "$ref": "GoogleIamV1Policy" }, "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "path": "v1beta1/{+resource}:getIamPolicy" }, "embedContent": { "response": { "$ref": "GoogleCloudAiplatformV1beta1EmbedContentResponse" }, "parameters": { "model": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "required": true, "description": "Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "path": "v1beta1/{+model}:embedContent", "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:embedContent", "request": { "$ref": "GoogleCloudAiplatformV1beta1EmbedContentRequest" }, "description": "Embed content with multimodal inputs.", "parameterOrder": [ "model" ], "id": "aiplatform.projects.locations.publishers.models.embedContent" }, "predictLongRunning": { "description": "", "id": "aiplatform.projects.locations.publishers.models.predictLongRunning", "path": "v1beta1/{+endpoint}:predictLongRunning", "request": { "$ref": "GoogleCloudAiplatformV1beta1PredictLongRunningRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "endpoint" ], "httpMethod": "POST", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predictLongRunning", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "parameters": { "endpoint": { "location": "path", "description": "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}`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "required": true } } } }, "resources": { "invoke": { "methods": { "invoke": { "path": "v1beta1/{+endpoint}/invoke/{+invokeId}", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}/invoke/{invokeId}", "request": { "$ref": "GoogleCloudAiplatformV1beta1InvokeRequest" }, "parameters": { "endpoint": { "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "required": true, "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "type": "string", "location": "path" }, "invokeId": { "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "endpoint", "invokeId" ], "response": { "$ref": "GoogleApiHttpBody" }, "id": "aiplatform.projects.locations.publishers.models.invoke.invoke", "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request." } } } } }, "v1": { "methods": { "responses": { "httpMethod": "POST", "parameters": { "endpoint": { "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+$", "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "required": true, "type": "string", "location": "path" }, "deployedModelId": { "type": "string", "description": "ID of the DeployedModel that serves the invoke request.", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "id": "aiplatform.projects.locations.publishers.v1.responses", "request": { "$ref": "GoogleApiHttpBody" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/v1/responses", "parameterOrder": [ "endpoint" ], "response": { "$ref": "GoogleApiHttpBody" }, "path": "v1beta1/{+endpoint}/v1/responses", "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request." } }, "resources": { "responses": { "methods": { "delete": { "description": "Deletes the response from the endpoint.", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/v1/responses/{responsesId}", "response": { "$ref": "GoogleApiHttpBody" }, "id": "aiplatform.projects.locations.publishers.v1.responses.delete", "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/v1/responses/[^/]+$", "required": true, "type": "string", "description": "Required. The name of the Response resource to be deleted. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}/responses/{response}`" } } }, "get": { "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.publishers.v1.responses.get", "description": "Gets the response from the endpoint.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/v1/responses/{responsesId}", "parameters": { "name": { "type": "string", "description": "Required. The name of the Response resource. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}/responses/{response}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/v1/responses/[^/]+$", "required": true } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "response": { "$ref": "GoogleApiHttpBody" } }, "compact": { "id": "aiplatform.projects.locations.publishers.v1.responses.compact", "parameters": { "deployedModelId": { "description": "ID of the DeployedModel that serves the invoke request.", "type": "string", "location": "query" }, "endpoint": { "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+$", "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "required": true, "type": "string", "location": "path" } }, "response": { "$ref": "GoogleApiHttpBody" }, "httpMethod": "POST", "path": "v1beta1/{+endpoint}/v1/responses/compact", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "parameterOrder": [ "endpoint" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/v1/responses/compact", "request": { "$ref": "GoogleApiHttpBody" }, "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request." } } } } } } }, "evaluationMetrics": { "methods": { "delete": { "parameters": { "name": { "type": "string", "description": "Required. The name of the EvaluationMetric resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationMetrics/{evaluation_metric}`", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/evaluationMetrics/[^/]+$" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics/{evaluationMetricsId}", "description": "Deletes an EvaluationMetric.", "path": "v1beta1/{+name}", "id": "aiplatform.projects.locations.evaluationMetrics.delete", "parameterOrder": [ "name" ] }, "create": { "path": "v1beta1/{+parent}/evaluationMetrics", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates an EvaluationMetric.", "response": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationMetric" }, "parameterOrder": [ "parent" ], "id": "aiplatform.projects.locations.evaluationMetrics.create", "parameters": { "parent": { "type": "string", "location": "path", "description": "Required. The resource name of the Location to create the EvaluationMetric in. Format: `projects/{project}/locations/{location}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" }, "evaluationMetricId": { "type": "string", "location": "query", "description": "Optional. The ID to use for the EvaluationMetric, which will become the final component of the EvaluationMetric's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or number." } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationMetric" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics", "httpMethod": "POST" }, "get": { "description": "Gets an EvaluationMetric.", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationMetric" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics/{evaluationMetricsId}", "id": "aiplatform.projects.locations.evaluationMetrics.get", "httpMethod": "GET", "path": "v1beta1/{+name}", "parameters": { "name": { "required": true, "description": "Required. The name of the EvaluationMetric resource. Format: `projects/{project}/locations/{location}/evaluationMetrics/{evaluation_metric}`", "pattern": "^projects/[^/]+/locations/[^/]+/evaluationMetrics/[^/]+$", "location": "path", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "parameterOrder": [ "parent" ], "description": "Lists EvaluationMetrics.", "id": "aiplatform.projects.locations.evaluationMetrics.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1ListEvaluationMetricsResponse" }, "path": "v1beta1/{+parent}/evaluationMetrics", "httpMethod": "GET", "parameters": { "parent": { "location": "path", "type": "string", "required": true, "description": "Required. The resource name of the Location from which to list the EvaluationMetrics. Format: `projects/{project}/locations/{location}`", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "description": "Optional. A page token, received from a previous `ListEvaluationMetrics` call. Provide this to retrieve the subsequent page.", "type": "string", "location": "query" }, "orderBy": { "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", "location": "query", "type": "string" }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "Optional. The maximum number of EvaluationMetrics to return." }, "filter": { "type": "string", "location": "query", "description": "Optional. Filter expression that matches a subset of the EvaluationMetrics to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160)." } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics" } }, "resources": { "operations": { "methods": { "delete": { "id": "aiplatform.projects.locations.evaluationMetrics.operations.delete", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "type": "string", "location": "path", "required": true, "description": "The name of the operation resource to be deleted.", "pattern": "^projects/[^/]+/locations/[^/]+/evaluationMetrics/[^/]+/operations/[^/]+$" } }, "path": "v1beta1/{+name}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics/{evaluationMetricsId}/operations/{operationsId}" }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics/{evaluationMetricsId}/operations", "id": "aiplatform.projects.locations.evaluationMetrics.operations.list", "path": "v1beta1/{+name}/operations", "parameters": { "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "returnPartialSuccess": { "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query" }, "pageSize": { "format": "int32", "location": "query", "description": "The standard list page size.", "type": "integer" }, "name": { "required": true, "description": "The name of the operation's parent resource.", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/evaluationMetrics/[^/]+$" }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "get": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics/{evaluationMetricsId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameters": { "name": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/evaluationMetrics/[^/]+/operations/[^/]+$", "description": "The name of the operation resource." } }, "id": "aiplatform.projects.locations.evaluationMetrics.operations.get", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "path": "v1beta1/{+name}" } } } } }, "memoryBanks": { "resources": { "operations": { "methods": { "wait": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}:wait", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.memoryBanks.operations.wait", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to wait on.", "required": true }, "timeout": { "location": "query", "format": "google-duration", "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." } }, "httpMethod": "POST" }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}", "id": "aiplatform.projects.locations.memoryBanks.operations.delete", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to be deleted.", "location": "path", "type": "string" } } }, "get": { "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}", "parameterOrder": [ "name" ], "id": "aiplatform.projects.locations.memoryBanks.operations.get", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "location": "path", "type": "string", "description": "The name of the operation resource.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$" } }, "httpMethod": "GET", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}" }, "list": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.memoryBanks.operations.list", "path": "v1beta1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", "required": true, "description": "The name of the operation's parent resource.", "location": "path" }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "pageSize": { "type": "integer", "description": "The standard list page size.", "location": "query", "format": "int32" }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" } } }, "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.projects.locations.memoryBanks.operations.cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", "type": "string", "location": "path", "description": "The name of the operation resource to be cancelled." } }, "httpMethod": "POST", "path": "v1beta1/{+name}:cancel" } } }, "memories": { "methods": { "generate": { "description": "Generate memories.", "path": "v1beta1/{+parent}/memories:generate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", "type": "string", "description": "Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path" } }, "id": "aiplatform.projects.locations.memoryBanks.memories.generate", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories:generate", "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequest" } }, "create": { "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+parent}/memories", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories", "request": { "$ref": "GoogleCloudAiplatformV1beta1Memory" }, "description": "Create a Memory.", "parameterOrder": [ "parent" ], "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`" }, "memoryId": { "location": "query", "description": "Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "id": "aiplatform.projects.locations.memoryBanks.memories.create" }, "list": { "path": "v1beta1/{+parent}/memories", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.memoryBanks.memories.list", "httpMethod": "GET", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListMemoriesResponse" }, "parameters": { "parent": { "description": "Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", "type": "string", "location": "path", "required": true }, "orderBy": { "type": "string", "description": "Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`", "location": "query" }, "pageToken": { "description": "Optional. The standard list page token.", "location": "query", "type": "string" }, "filter": { "type": "string", "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `scope` (as a JSON string with equality match only) * `topics` (i.e. `topics.custom_memory_topic_label: \"example topic\" OR topics.managed_memory_topic: USER_PREFERENCES`)", "location": "query" }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "Optional. The standard list page size." } }, "parameterOrder": [ "parent" ], "description": "List Memories.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories" }, "retrieveProfiles": { "path": "v1beta1/{+parent}/memories:retrieveProfiles", "httpMethod": "POST", "parameters": { "parent": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", "description": "Required. The resource name of the ReasoningEngine to retrieve profiles from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1RetrieveProfilesResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories:retrieveProfiles", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1RetrieveProfilesRequest" }, "id": "aiplatform.projects.locations.memoryBanks.memories.retrieveProfiles", "description": "Retrieves profiles.", "parameterOrder": [ "parent" ] }, "patch": { "parameters": { "updateMask": { "description": "Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type`", "type": "string", "location": "query", "format": "google-fieldmask" }, "name": { "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", "required": true, "description": "Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`" } }, "id": "aiplatform.projects.locations.memoryBanks.memories.patch", "request": { "$ref": "GoogleCloudAiplatformV1beta1Memory" }, "httpMethod": "PATCH", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "description": "Update a Memory.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "rollback": { "parameters": { "name": { "location": "path", "type": "string", "description": "Required. The resource name of the Memory to rollback. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$" } }, "path": "v1beta1/{+name}:rollback", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Rollback Memory to a specific revision.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}:rollback", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1RollbackMemoryRequest" }, "id": "aiplatform.projects.locations.memoryBanks.memories.rollback", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "retrieve": { "request": { "$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequest" }, "path": "v1beta1/{+parent}/memories:retrieve", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesResponse" }, "id": "aiplatform.projects.locations.memoryBanks.memories.retrieve", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories:retrieve", "parameterOrder": [ "parent" ], "httpMethod": "POST", "description": "Retrieve memories.", "parameters": { "parent": { "type": "string", "required": true, "description": "Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", "location": "path" } } }, "delete": { "id": "aiplatform.projects.locations.memoryBanks.memories.delete", "description": "Delete a Memory.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "parameters": { "name": { "required": true, "description": "Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "description": "Get a Memory.", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", "location": "path", "description": "Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "type": "string", "required": true } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}", "httpMethod": "GET", "id": "aiplatform.projects.locations.memoryBanks.memories.get", "response": { "$ref": "GoogleCloudAiplatformV1beta1Memory" }, "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "purge": { "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", "required": true, "description": "Required. The resource name of the ReasoningEngine to purge memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path" } }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "path": "v1beta1/{+parent}/memories:purge", "request": { "$ref": "GoogleCloudAiplatformV1beta1PurgeMemoriesRequest" }, "description": "Purge memories.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories:purge", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.locations.memoryBanks.memories.purge" } }, "resources": { "operations": { "methods": { "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "aiplatform.projects.locations.memoryBanks.memories.operations.delete", "parameterOrder": [ "name" ], "httpMethod": "DELETE", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation resource to be deleted." } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" } }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.memoryBanks.memories.operations.list", "path": "v1beta1/{+name}/operations", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations", "parameterOrder": [ "name" ], "parameters": { "pageSize": { "location": "query", "type": "integer", "description": "The standard list page size.", "format": "int32" }, "name": { "location": "path", "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", "type": "string", "required": true }, "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" } }, "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "httpMethod": "GET" }, "wait": { "httpMethod": "POST", "parameters": { "name": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to wait on.", "location": "path" }, "timeout": { "format": "google-duration", "type": "string", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." } }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:wait", "id": "aiplatform.projects.locations.memoryBanks.memories.operations.wait", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource.", "type": "string", "location": "path" } }, "id": "aiplatform.projects.locations.memoryBanks.memories.operations.get", "httpMethod": "GET", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "cancel": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "path": "v1beta1/{+name}:cancel", "id": "aiplatform.projects.locations.memoryBanks.memories.operations.cancel", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "required": true, "description": "The name of the operation resource to be cancelled.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$" } }, "httpMethod": "POST" } } }, "revisions": { "methods": { "list": { "path": "v1beta1/{+parent}/revisions", "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "Optional. The standard list page size." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", "required": true, "location": "path", "description": "Required. The resource name of the Memory to list revisions for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "type": "string" }, "filter": { "location": "query", "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels`", "type": "string" }, "pageToken": { "description": "Optional. The standard list page token.", "location": "query", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/revisions", "id": "aiplatform.projects.locations.memoryBanks.memories.revisions.list", "description": "List Memory Revisions for a Memory.", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListMemoryRevisionsResponse" } }, "get": { "parameterOrder": [ "name" ], "description": "Get a Memory Revision.", "httpMethod": "GET", "parameters": { "name": { "required": true, "type": "string", "description": "Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{revision}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/revisions/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1MemoryRevision" }, "id": "aiplatform.projects.locations.memoryBanks.memories.revisions.get", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/revisions/{revisionsId}", "path": "v1beta1/{+name}" } } } } } }, "methods": { "ingestEvents": { "parameters": { "parent": { "required": true, "type": "string", "description": "Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$" } }, "httpMethod": "POST", "path": "v1beta1/{+parent}:ingestEvents", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.memoryBanks.ingestEvents", "request": { "$ref": "GoogleCloudAiplatformV1beta1IngestEventsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}:ingestEvents", "description": "Ingests events for a Memory Bank." } } }, "agentAnomalyDetectionScopes": { "methods": { "list": { "id": "aiplatform.projects.locations.agentAnomalyDetectionScopes.list", "path": "v1beta1/{+parent}/agentAnomalyDetectionScopes", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListAgentAnomalyDetectionScopesResponse" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agentAnomalyDetectionScopes", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists AgentAnomalyDetectionScopes in a Location.", "parameters": { "pageSize": { "format": "int32", "description": "Optional. The standard list page size. The maximum value is 100; values above 100 will be coerced to 100. If unspecified, at most 10 AgentAnomalyDetectionScopes will be returned.", "location": "query", "type": "integer" }, "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The resource name of the Location to list the AgentAnomalyDetectionScopes from. Format: `projects/{project}/locations/{location}`", "required": true }, "pageToken": { "type": "string", "description": "Optional. The standard list page token.", "location": "query" } }, "parameterOrder": [ "parent" ], "httpMethod": "GET" }, "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.projects.locations.agentAnomalyDetectionScopes.create", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agentAnomalyDetectionScopes", "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope" }, "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/agentAnomalyDetectionScopes", "httpMethod": "POST", "description": "Creates a new AgentAnomalyDetectionScope.", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Required. The resource name of the Location to create the AgentAnomalyDetectionScope in. Format: `projects/{project}/locations/{location}`", "required": true, "type": "string" }, "agentAnomalyDetectionScopeId": { "location": "query", "type": "string", "description": "Required. The ID to use for the AgentAnomalyDetectionScope, which will become the final component of the AgentAnomalyDetectionScope's resource name. This value should be 1-63 characters, and valid characters are /[a-z]([a-z0-9-]{0,61}[a-z0-9])?/." } } }, "delete": { "description": "Deletes a specific AgentAnomalyDetectionScope.", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/agentAnomalyDetectionScopes/[^/]+$", "location": "path", "type": "string", "required": true, "description": "Required. The name of the AgentAnomalyDetectionScope resource to be deleted. Format: `projects/{project}/locations/{location}/agentAnomalyDetectionScopes/{agent_anomaly_detection_scope}`" } }, "id": "aiplatform.projects.locations.agentAnomalyDetectionScopes.delete", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agentAnomalyDetectionScopes/{agentAnomalyDetectionScopesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "response": { "$ref": "GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope" }, "httpMethod": "GET", "path": "v1beta1/{+name}", "parameters": { "name": { "location": "path", "description": "Required. The name of the AgentAnomalyDetectionScope resource. Format: `projects/{project}/locations/{location}/agentAnomalyDetectionScopes/{agent_anomaly_detection_scope}`", "pattern": "^projects/[^/]+/locations/[^/]+/agentAnomalyDetectionScopes/[^/]+$", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "description": "Gets the details of a specific AgentAnomalyDetectionScope.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agentAnomalyDetectionScopes/{agentAnomalyDetectionScopesId}", "id": "aiplatform.projects.locations.agentAnomalyDetectionScopes.get" } } } } }, "modelGardenEula": { "methods": { "accept": { "id": "aiplatform.projects.modelGardenEula.accept", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Accepts the EULA acceptance status of a publisher model.", "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "type": "string", "description": "Required. The project requesting access for named model. The format is `projects/{project}`.", "pattern": "^projects/[^/]+$", "location": "path", "required": true } }, "flatPath": "v1beta1/projects/{projectsId}/modelGardenEula:accept", "response": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelEulaAcceptance" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1AcceptPublisherModelEulaRequest" }, "path": "v1beta1/{+parent}/modelGardenEula:accept" }, "check": { "request": { "$ref": "GoogleCloudAiplatformV1beta1CheckPublisherModelEulaAcceptanceRequest" }, "path": "v1beta1/{+parent}/modelGardenEula:check", "response": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelEulaAcceptance" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "flatPath": "v1beta1/projects/{projectsId}/modelGardenEula:check", "parameters": { "parent": { "location": "path", "type": "string", "description": "Required. The project requesting access for named model. The format is `projects/{project}`.", "required": true, "pattern": "^projects/[^/]+$" } }, "httpMethod": "POST", "description": "Checks the EULA acceptance status of a publisher model.", "id": "aiplatform.projects.modelGardenEula.check" } } }, "publishers": { "resources": { "models": { "methods": { "enableModel": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Enables model for the project if prerequisites are met (e.g. completed questionnaire and consents, or an active Private Offer).", "id": "aiplatform.projects.publishers.models.enableModel", "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1EnableModelRequest" }, "response": { "$ref": "GoogleCloudAiplatformV1beta1EnableModelResponse" }, "parameters": { "parent": { "required": true, "location": "path", "description": "Required. The project requesting access for named model. Format: `projects/{project}`", "type": "string", "pattern": "^projects/[^/]+$" }, "name": { "location": "path", "description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`", "pattern": "^publishers/[^/]+/models/[^/]+$", "type": "string", "required": true } }, "parameterOrder": [ "parent", "name" ], "path": "v1beta1/{+parent}/{+name}:enableModel", "flatPath": "v1beta1/projects/{projectsId}/publishers/{publishersId}/models/{modelsId}:enableModel" } } } } } }, "methods": { "getCacheConfig": { "response": { "$ref": "GoogleCloudAiplatformV1beta1CacheConfig" }, "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}/cacheConfig", "id": "aiplatform.projects.getCacheConfig", "description": "Gets a GenAI cache config.", "parameters": { "name": { "location": "path", "description": "Required. Name of the cache config. Format: - `projects/{project}/cacheConfig`.", "type": "string", "required": true, "pattern": "^projects/[^/]+/cacheConfig$" } }, "httpMethod": "GET" }, "fetchPublisherModelConfig": { "response": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelConfig" }, "path": "v1beta1/{+name}:fetchPublisherModelConfig", "parameterOrder": [ "name" ], "flatPath": "v1beta1/projects/{projectsId}:fetchPublisherModelConfig", "description": "Fetches the configs of publisher models.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+$", "location": "path", "type": "string", "required": true, "description": "Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`." } }, "id": "aiplatform.projects.fetchPublisherModelConfig" }, "updateCacheConfig": { "parameterOrder": [ "name" ], "description": "Updates a cache config.", "flatPath": "v1beta1/projects/{projectsId}/cacheConfig", "request": { "$ref": "GoogleCloudAiplatformV1beta1CacheConfig" }, "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.projects.updateCacheConfig", "httpMethod": "PATCH", "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/cacheConfig$", "required": true, "description": "Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`." } }, "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "setPublisherModelConfig": { "id": "aiplatform.projects.setPublisherModelConfig", "path": "v1beta1/{+name}:setPublisherModelConfig", "description": "Sets (creates or updates) configs of publisher models. For example, sets the request/response logging config.", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "description": "Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.", "pattern": "^projects/[^/]+$", "type": "string", "required": true } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1SetPublisherModelConfigRequest" }, "flatPath": "v1beta1/projects/{projectsId}:setPublisherModelConfig" } } }, "v1beta1": { "methods": { "generateInstanceRubrics": { "parameterOrder": [], "description": "Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations.", "request": { "$ref": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsRequest" }, "path": "v1beta1:generateInstanceRubrics", "id": "aiplatform.generateInstanceRubrics", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1:generateInstanceRubrics", "parameters": {}, "httpMethod": "POST", "response": { "$ref": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsResponse" } }, "evaluateInstances": { "parameters": {}, "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1EvaluateInstancesRequest" }, "response": { "$ref": "GoogleCloudAiplatformV1beta1EvaluateInstancesResponse" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.evaluateInstances", "parameterOrder": [], "path": "v1beta1:evaluateInstances", "flatPath": "v1beta1:evaluateInstances", "description": "Evaluates instances based on a given metric." }, "evaluateDataset": { "parameters": {}, "request": { "$ref": "GoogleCloudAiplatformV1beta1EvaluateDatasetRequest" }, "httpMethod": "POST", "parameterOrder": [], "path": "v1beta1:evaluateDataset", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.evaluateDataset", "flatPath": "v1beta1:evaluateDataset", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Evaluates a dataset based on a set of given metrics." } } }, "ragCorpora": { "resources": { "ragFiles": { "resources": { "operations": { "methods": { "get": { "flatPath": "v1beta1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "id": "aiplatform.ragCorpora.ragFiles.operations.get", "httpMethod": "GET", "parameters": { "name": { "location": "path", "required": true, "pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", "description": "The name of the operation resource.", "type": "string" } }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.ragCorpora.ragFiles.operations.delete", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "location": "path", "pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", "type": "string", "required": true } }, "httpMethod": "DELETE", "flatPath": "v1beta1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}" }, "cancel": { "path": "v1beta1/{+name}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.ragCorpora.ragFiles.operations.cancel", "flatPath": "v1beta1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:cancel", "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", "type": "string", "required": true, "pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$" } }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "parameters": { "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "pageSize": { "location": "query", "type": "integer", "description": "The standard list page size.", "format": "int32" }, "name": { "description": "The name of the operation's parent resource.", "pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+$", "type": "string", "required": true, "location": "path" } }, "httpMethod": "GET", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "flatPath": "v1beta1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations", "path": "v1beta1/{+name}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.ragCorpora.ragFiles.operations.list" }, "wait": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:wait", "httpMethod": "POST", "parameters": { "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "format": "google-duration", "type": "string" }, "name": { "pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to wait on.", "required": true, "type": "string" } }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:wait", "id": "aiplatform.ragCorpora.ragFiles.operations.wait" } } } } }, "operations": { "methods": { "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "flatPath": "v1beta1/ragCorpora/{ragCorporaId}/operations/{operationsId}", "id": "aiplatform.ragCorpora.operations.delete", "parameters": { "name": { "type": "string", "pattern": "^ragCorpora/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "required": true, "location": "path" } }, "httpMethod": "DELETE", "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v1beta1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/ragCorpora/{ragCorporaId}/operations", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "pageSize": { "description": "The standard list page size.", "type": "integer", "location": "query", "format": "int32" }, "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "name": { "location": "path", "type": "string", "required": true, "pattern": "^ragCorpora/[^/]+$", "description": "The name of the operation's parent resource." } }, "id": "aiplatform.ragCorpora.operations.list" }, "cancel": { "flatPath": "v1beta1/ragCorpora/{ragCorporaId}/operations/{operationsId}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}:cancel", "parameterOrder": [ "name" ], "id": "aiplatform.ragCorpora.operations.cancel", "parameters": { "name": { "required": true, "location": "path", "type": "string", "pattern": "^ragCorpora/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be cancelled." } }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST" }, "get": { "id": "aiplatform.ragCorpora.operations.get", "flatPath": "v1beta1/ragCorpora/{ragCorporaId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^ragCorpora/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource.", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ] }, "wait": { "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameterOrder": [ "name" ], "id": "aiplatform.ragCorpora.operations.wait", "flatPath": "v1beta1/ragCorpora/{ragCorporaId}/operations/{operationsId}:wait", "path": "v1beta1/{+name}:wait", "parameters": { "name": { "location": "path", "description": "The name of the operation resource to wait on.", "type": "string", "required": true, "pattern": "^ragCorpora/[^/]+/operations/[^/]+$" }, "timeout": { "location": "query", "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration" } }, "httpMethod": "POST" } } } } }, "evaluationTasks": { "resources": { "operations": { "methods": { "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "aiplatform.evaluationTasks.operations.list", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1beta1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "name": { "required": true, "pattern": "^evaluationTasks/[^/]+$", "location": "path", "description": "The name of the operation's parent resource.", "type": "string" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "pageSize": { "location": "query", "description": "The standard list page size.", "format": "int32", "type": "integer" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" } }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/evaluationTasks/{evaluationTasksId}/operations" }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameters": { "name": { "pattern": "^evaluationTasks/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "location": "path", "required": true, "type": "string" } }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/evaluationTasks/{evaluationTasksId}/operations/{operationsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "id": "aiplatform.evaluationTasks.operations.delete" }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "id": "aiplatform.evaluationTasks.operations.get", "flatPath": "v1beta1/evaluationTasks/{evaluationTasksId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^evaluationTasks/[^/]+/operations/[^/]+$", "required": true, "location": "path", "type": "string" } } }, "wait": { "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:wait", "flatPath": "v1beta1/evaluationTasks/{evaluationTasksId}/operations/{operationsId}:wait", "parameters": { "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "format": "google-duration", "type": "string" }, "name": { "description": "The name of the operation resource to wait on.", "location": "path", "pattern": "^evaluationTasks/[^/]+/operations/[^/]+$", "type": "string", "required": true } }, "parameterOrder": [ "name" ], "id": "aiplatform.evaluationTasks.operations.wait", "httpMethod": "POST" } } } } }, "notebookRuntimeTemplates": { "resources": { "operations": { "methods": { "get": { "flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "path": "v1beta1/{+name}", "id": "aiplatform.notebookRuntimeTemplates.operations.get", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "required": true } }, "httpMethod": "GET" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameters": { "name": { "location": "path", "type": "string", "description": "The name of the operation resource to be deleted.", "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "id": "aiplatform.notebookRuntimeTemplates.operations.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}" }, "wait": { "httpMethod": "POST", "parameters": { "timeout": { "type": "string", "location": "query", "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." }, "name": { "required": true, "description": "The name of the operation resource to wait on.", "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "location": "path", "type": "string" } }, "path": "v1beta1/{+name}:wait", "id": "aiplatform.notebookRuntimeTemplates.operations.wait", "flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait", "parameterOrder": [ "name" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" } }, "cancel": { "httpMethod": "POST", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:cancel", "parameters": { "name": { "type": "string", "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to be cancelled.", "location": "path" } }, "id": "aiplatform.notebookRuntimeTemplates.operations.cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "parameters": { "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "name": { "location": "path", "pattern": "^notebookRuntimeTemplates/[^/]+$", "type": "string", "description": "The name of the operation's parent resource.", "required": true }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "pageSize": { "format": "int32", "description": "The standard list page size.", "location": "query", "type": "integer" }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" } }, "flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations", "parameterOrder": [ "name" ], "httpMethod": "GET", "id": "aiplatform.notebookRuntimeTemplates.operations.list", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1beta1/{+name}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } } } } }, "evaluationRuns": { "resources": { "operations": { "methods": { "list": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}/operations", "id": "aiplatform.evaluationRuns.operations.list", "parameters": { "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "name": { "pattern": "^evaluationRuns/[^/]+$", "required": true, "description": "The name of the operation's parent resource.", "type": "string", "location": "path" }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." } }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "flatPath": "v1beta1/evaluationRuns/{evaluationRunsId}/operations" }, "get": { "parameters": { "name": { "location": "path", "required": true, "type": "string", "description": "The name of the operation resource.", "pattern": "^evaluationRuns/[^/]+/operations/[^/]+$" } }, "httpMethod": "GET", "id": "aiplatform.evaluationRuns.operations.get", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "path": "v1beta1/{+name}", "flatPath": "v1beta1/evaluationRuns/{evaluationRunsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ] }, "delete": { "parameters": { "name": { "required": true, "description": "The name of the operation resource to be deleted.", "pattern": "^evaluationRuns/[^/]+/operations/[^/]+$", "location": "path", "type": "string" } }, "httpMethod": "DELETE", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.evaluationRuns.operations.delete", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "flatPath": "v1beta1/evaluationRuns/{evaluationRunsId}/operations/{operationsId}" }, "wait": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "httpMethod": "POST", "parameterOrder": [ "name" ], "parameters": { "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration", "location": "query", "type": "string" }, "name": { "pattern": "^evaluationRuns/[^/]+/operations/[^/]+$", "required": true, "type": "string", "description": "The name of the operation resource to wait on.", "location": "path" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}:wait", "id": "aiplatform.evaluationRuns.operations.wait", "flatPath": "v1beta1/evaluationRuns/{evaluationRunsId}/operations/{operationsId}:wait" } } } } }, "deploymentResourcePools": { "resources": { "operations": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.deploymentResourcePools.operations.get", "flatPath": "v1beta1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "type": "string", "description": "The name of the operation resource.", "required": true, "pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$", "location": "path" } }, "httpMethod": "GET", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}" }, "list": { "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1beta1/{+name}/operations", "flatPath": "v1beta1/deploymentResourcePools/{deploymentResourcePoolsId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.deploymentResourcePools.operations.list", "httpMethod": "GET", "parameters": { "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "The standard list page size." }, "returnPartialSuccess": { "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query" }, "name": { "required": true, "description": "The name of the operation's parent resource.", "type": "string", "location": "path", "pattern": "^deploymentResourcePools/[^/]+$" } } }, "wait": { "flatPath": "v1beta1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait", "parameterOrder": [ "name" ], "id": "aiplatform.deploymentResourcePools.operations.wait", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameters": { "name": { "required": true, "type": "string", "pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to wait on." }, "timeout": { "type": "string", "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST" }, "cancel": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "id": "aiplatform.deploymentResourcePools.operations.cancel", "flatPath": "v1beta1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation resource to be cancelled.", "pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$", "location": "path" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "POST" }, "delete": { "parameters": { "name": { "type": "string", "location": "path", "description": "The name of the operation resource to be deleted.", "pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$", "required": true } }, "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE", "path": "v1beta1/{+name}", "flatPath": "v1beta1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "aiplatform.deploymentResourcePools.operations.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] } } } } }, "semanticGovernancePolicies": { "resources": { "operations": { "methods": { "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "path": "v1beta1/{+name}:wait", "parameterOrder": [ "name" ], "id": "aiplatform.semanticGovernancePolicies.operations.wait", "httpMethod": "POST", "parameters": { "name": { "type": "string", "location": "path", "description": "The name of the operation resource to wait on.", "required": true, "pattern": "^semanticGovernancePolicies/[^/]+/operations/[^/]+$" }, "timeout": { "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}:wait", "response": { "$ref": "GoogleLongrunningOperation" } }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "id": "aiplatform.semanticGovernancePolicies.operations.get", "flatPath": "v1beta1/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "httpMethod": "GET", "parameters": { "name": { "required": true, "pattern": "^semanticGovernancePolicies/[^/]+/operations/[^/]+$", "type": "string", "location": "path", "description": "The name of the operation resource." } } }, "list": { "parameterOrder": [ "name" ], "id": "aiplatform.semanticGovernancePolicies.operations.list", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}/operations", "httpMethod": "GET", "flatPath": "v1beta1/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations", "parameters": { "name": { "required": true, "description": "The name of the operation's parent resource.", "type": "string", "location": "path", "pattern": "^semanticGovernancePolicies/[^/]+$" }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "pageSize": { "description": "The standard list page size.", "type": "integer", "format": "int32", "location": "query" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" } }, "response": { "$ref": "GoogleLongrunningListOperationsResponse" } }, "delete": { "flatPath": "v1beta1/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}", "parameters": { "name": { "pattern": "^semanticGovernancePolicies/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource to be deleted.", "required": true, "location": "path" } }, "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "id": "aiplatform.semanticGovernancePolicies.operations.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." }, "cancel": { "path": "v1beta1/{+name}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "id": "aiplatform.semanticGovernancePolicies.operations.cancel", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "type": "string", "pattern": "^semanticGovernancePolicies/[^/]+/operations/[^/]+$", "location": "path", "required": true, "description": "The name of the operation resource to be cancelled." } }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}:cancel" } } } } }, "interactions": { "methods": { "cancel": { "httpMethod": "POST", "parameters": { "name": { "pattern": "^interactions/[^/]+$", "description": "Required. The name of the interaction to cancel. Format: `interactions/{interaction}`.", "location": "path", "required": true, "type": "string" } }, "path": "v1beta1/{+name}:cancel", "response": { "$ref": "GenaiVertexV1beta1Interaction" }, "id": "aiplatform.interactions.cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Cancels an interaction.", "parameterOrder": [ "name" ], "flatPath": "v1beta1/interactions/{interactionsId}:cancel" }, "getPoll": { "description": "Fully typed proto, unary version of GetInteraction that returns Interaction proto.", "path": "v1beta1/{+name}:poll", "parameters": { "name": { "type": "string", "location": "path", "pattern": "^interactions/[^/]+$", "description": "Required. The name of the interaction to retrieve. Format: interactions/{interaction}", "required": true }, "lastEventId": { "location": "query", "type": "string", "description": "If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if `stream` is true." }, "stream": { "description": "If true, streams the interaction events as Server-Sent Events.", "type": "boolean", "location": "query" }, "includeInput": { "type": "boolean", "description": "If true, includes the input in the response.", "location": "query", "deprecated": true } }, "id": "aiplatform.interactions.getPoll", "httpMethod": "GET", "response": { "$ref": "GenaiVertexV1beta1Interaction" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/interactions/{interactionsId}:poll", "parameterOrder": [ "name" ] }, "getStream": { "parameters": { "includeInput": { "deprecated": true, "description": "If true, includes the input in the response.", "location": "query", "type": "boolean" }, "name": { "required": true, "pattern": "^interactions/[^/]+$", "location": "path", "description": "Required. The name of the interaction to retrieve. Format: interactions/{interaction}", "type": "string" }, "lastEventId": { "description": "If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if `stream` is true.", "type": "string", "location": "query" }, "stream": { "type": "boolean", "location": "query", "description": "If true, streams the interaction events as Server-Sent Events." } }, "path": "v1beta1/{+name}:stream", "id": "aiplatform.interactions.getStream", "httpMethod": "GET", "parameterOrder": [ "name" ], "description": "Fully typed proto, streaming version of GetInteraction that returns Interaction proto.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/interactions/{interactionsId}:stream", "response": { "$ref": "GenaiVertexV1beta1InteractionStreamingEvent" } } } }, "evaluationMetrics": { "resources": { "operations": { "methods": { "delete": { "parameters": { "name": { "required": true, "type": "string", "location": "path", "pattern": "^evaluationMetrics/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted." } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.evaluationMetrics.operations.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/evaluationMetrics/{evaluationMetricsId}/operations/{operationsId}", "path": "v1beta1/{+name}" }, "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}/operations", "id": "aiplatform.evaluationMetrics.operations.list", "flatPath": "v1beta1/evaluationMetrics/{evaluationMetricsId}/operations", "parameters": { "name": { "pattern": "^evaluationMetrics/[^/]+$", "required": true, "description": "The name of the operation's parent resource.", "type": "string", "location": "path" }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "format": "int32", "type": "integer" } }, "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "parameters": { "name": { "pattern": "^evaluationMetrics/[^/]+/operations/[^/]+$", "description": "The name of the operation resource.", "location": "path", "type": "string", "required": true } }, "flatPath": "v1beta1/evaluationMetrics/{evaluationMetricsId}/operations/{operationsId}", "parameterOrder": [ "name" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "id": "aiplatform.evaluationMetrics.operations.get" } } } } }, "batchPredictionJobs": { "methods": { "list": { "response": { "$ref": "GoogleCloudAiplatformV1beta1ListBatchPredictionJobsResponse" }, "description": "Lists BatchPredictionJobs in a Location.", "id": "aiplatform.batchPredictionJobs.list", "parameters": { "filter": { "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`\u003c`, `\u003c=`,`\u003e`, `\u003e=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time\u003e\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", "location": "query", "type": "string" }, "readMask": { "location": "query", "description": "Mask specifying which fields to read.", "type": "string", "format": "google-fieldmask" }, "parent": { "description": "Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project}/locations/{location}`", "location": "query", "type": "string" }, "pageToken": { "description": "The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call.", "type": "string", "location": "query" }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "The standard list page size." } }, "flatPath": "v1beta1/batchPredictionJobs", "parameterOrder": [], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/batchPredictionJobs" }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "response": { "$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob" }, "description": "Gets a BatchPredictionJob", "flatPath": "v1beta1/batchPredictionJobs/{batchPredictionJobsId}", "httpMethod": "GET", "parameters": { "name": { "pattern": "^batchPredictionJobs/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The name of the BatchPredictionJob resource. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`" } }, "parameterOrder": [ "name" ], "id": "aiplatform.batchPredictionJobs.get" }, "create": { "flatPath": "v1beta1/batchPredictionJobs", "path": "v1beta1/batchPredictionJobs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob" }, "parameterOrder": [], "id": "aiplatform.batchPredictionJobs.create", "httpMethod": "POST", "description": "Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.", "request": { "$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob" }, "parameters": { "parent": { "location": "query", "type": "string", "description": "Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}`" } } } } }, "hyperparameterTuningJobs": { "resources": { "operations": { "methods": { "delete": { "httpMethod": "DELETE", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "type": "string", "required": true, "pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$", "location": "path" } }, "flatPath": "v1beta1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.hyperparameterTuningJobs.operations.delete", "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameters": { "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "The standard list page size." }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "name": { "type": "string", "pattern": "^hyperparameterTuningJobs/[^/]+$", "location": "path", "description": "The name of the operation's parent resource.", "required": true }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" } }, "flatPath": "v1beta1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations", "path": "v1beta1/{+name}/operations", "id": "aiplatform.hyperparameterTuningJobs.operations.list" }, "cancel": { "parameterOrder": [ "name" ], "flatPath": "v1beta1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "id": "aiplatform.hyperparameterTuningJobs.operations.cancel", "httpMethod": "POST", "parameters": { "name": { "pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string", "description": "The name of the operation resource to be cancelled.", "location": "path" } } }, "get": { "httpMethod": "GET", "id": "aiplatform.hyperparameterTuningJobs.operations.get", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path", "description": "The name of the operation resource." } }, "flatPath": "v1beta1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}", "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}" }, "wait": { "parameters": { "name": { "required": true, "description": "The name of the operation resource to wait on.", "type": "string", "location": "path", "pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$" }, "timeout": { "location": "query", "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string" } }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}:wait", "id": "aiplatform.hyperparameterTuningJobs.operations.wait", "flatPath": "v1beta1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait" } } } } }, "taskStores": { "resources": { "operations": { "methods": { "cancel": { "parameterOrder": [ "name" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "path": "v1beta1/{+name}:cancel", "id": "aiplatform.taskStores.operations.cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/taskStores/{taskStoresId}/operations/{operationsId}:cancel", "httpMethod": "POST", "parameters": { "name": { "type": "string", "required": true, "description": "The name of the operation resource to be cancelled.", "pattern": "^taskStores/[^/]+/operations/[^/]+$", "location": "path" } }, "response": { "$ref": "GoogleProtobufEmpty" } }, "get": { "parameterOrder": [ "name" ], "id": "aiplatform.taskStores.operations.get", "httpMethod": "GET", "parameters": { "name": { "location": "path", "pattern": "^taskStores/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource.", "type": "string" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/taskStores/{taskStoresId}/operations/{operationsId}" }, "list": { "id": "aiplatform.taskStores.operations.list", "parameters": { "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "name": { "pattern": "^taskStores/[^/]+$", "required": true, "description": "The name of the operation's parent resource.", "type": "string", "location": "path" }, "pageSize": { "location": "query", "description": "The standard list page size.", "format": "int32", "type": "integer" }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" } }, "parameterOrder": [ "name" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "flatPath": "v1beta1/taskStores/{taskStoresId}/operations", "path": "v1beta1/{+name}/operations" }, "delete": { "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "pattern": "^taskStores/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation resource to be deleted.", "required": true } }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "flatPath": "v1beta1/taskStores/{taskStoresId}/operations/{operationsId}", "id": "aiplatform.taskStores.operations.delete", "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "wait": { "flatPath": "v1beta1/taskStores/{taskStoresId}/operations/{operationsId}:wait", "id": "aiplatform.taskStores.operations.wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:wait", "parameters": { "name": { "pattern": "^taskStores/[^/]+/operations/[^/]+$", "type": "string", "required": true, "description": "The name of the operation resource to wait on.", "location": "path" }, "timeout": { "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "format": "google-duration" } }, "httpMethod": "POST" } } } } }, "studies": { "resources": { "operations": { "methods": { "list": { "path": "v1beta1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "The standard list page size." }, "name": { "type": "string", "required": true, "description": "The name of the operation's parent resource.", "location": "path", "pattern": "^studies/[^/]+$" }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" } }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/studies/{studiesId}/operations", "id": "aiplatform.studies.operations.list" }, "wait": { "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "flatPath": "v1beta1/studies/{studiesId}/operations/{operationsId}:wait", "id": "aiplatform.studies.operations.wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration", "location": "query", "type": "string" }, "name": { "required": true, "location": "path", "description": "The name of the operation resource to wait on.", "type": "string", "pattern": "^studies/[^/]+/operations/[^/]+$" } }, "parameterOrder": [ "name" ], "httpMethod": "POST" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.studies.operations.delete", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "location": "path", "type": "string", "required": true, "pattern": "^studies/[^/]+/operations/[^/]+$" } }, "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "flatPath": "v1beta1/studies/{studiesId}/operations/{operationsId}" }, "cancel": { "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", "type": "string", "required": true, "pattern": "^studies/[^/]+/operations/[^/]+$" } }, "flatPath": "v1beta1/studies/{studiesId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ], "httpMethod": "POST", "path": "v1beta1/{+name}:cancel", "id": "aiplatform.studies.operations.cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." }, "get": { "path": "v1beta1/{+name}", "flatPath": "v1beta1/studies/{studiesId}/operations/{operationsId}", "id": "aiplatform.studies.operations.get", "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "GET", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameters": { "name": { "location": "path", "required": true, "description": "The name of the operation resource.", "type": "string", "pattern": "^studies/[^/]+/operations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] } } }, "trials": { "resources": { "operations": { "methods": { "list": { "parameterOrder": [ "name" ], "id": "aiplatform.studies.trials.operations.list", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameters": { "pageSize": { "type": "integer", "format": "int32", "description": "The standard list page size.", "location": "query" }, "name": { "pattern": "^studies/[^/]+/trials/[^/]+$", "description": "The name of the operation's parent resource.", "location": "path", "type": "string", "required": true }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" } }, "flatPath": "v1beta1/studies/{studiesId}/trials/{trialsId}/operations", "path": "v1beta1/{+name}/operations", "httpMethod": "GET" }, "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel", "parameters": { "name": { "location": "path", "pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be cancelled.", "type": "string", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "path": "v1beta1/{+name}:cancel", "id": "aiplatform.studies.trials.operations.cancel" }, "wait": { "parameterOrder": [ "name" ], "flatPath": "v1beta1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait", "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "id": "aiplatform.studies.trials.operations.wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "format": "google-duration", "type": "string" }, "name": { "type": "string", "required": true, "pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to wait on." } }, "httpMethod": "POST" }, "delete": { "path": "v1beta1/{+name}", "id": "aiplatform.studies.trials.operations.delete", "parameters": { "name": { "pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be deleted.", "required": true, "type": "string" } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "flatPath": "v1beta1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}" }, "get": { "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "name": { "type": "string", "required": true, "description": "The name of the operation resource.", "pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$", "location": "path" } }, "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", "id": "aiplatform.studies.trials.operations.get", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." } } } } } } }, "endpoints": { "resources": { "chat": { "methods": { "completions": { "flatPath": "v1beta1/endpoints/{endpointsId}/chat/completions", "request": { "$ref": "GoogleApiHttpBody" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "response": { "$ref": "GoogleApiHttpBody" }, "httpMethod": "POST", "description": "Exposes an OpenAI-compatible endpoint for chat completions.", "parameters": { "endpoint": { "pattern": "^endpoints/[^/]+$", "type": "string", "description": "Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "required": true, "location": "path" } }, "parameterOrder": [ "endpoint" ], "path": "v1beta1/{+endpoint}/chat/completions", "id": "aiplatform.endpoints.chat.completions" } } }, "operations": { "methods": { "wait": { "flatPath": "v1beta1/endpoints/{endpointsId}/operations/{operationsId}:wait", "path": "v1beta1/{+name}:wait", "httpMethod": "POST", "parameters": { "name": { "required": true, "location": "path", "pattern": "^endpoints/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource to wait on." }, "timeout": { "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "format": "google-duration" } }, "id": "aiplatform.endpoints.operations.wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameterOrder": [ "name" ] }, "get": { "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/endpoints/{endpointsId}/operations/{operationsId}", "id": "aiplatform.endpoints.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "required": true, "type": "string", "description": "The name of the operation resource.", "pattern": "^endpoints/[^/]+/operations/[^/]+$" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "id": "aiplatform.endpoints.operations.list", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameters": { "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "name": { "required": true, "type": "string", "description": "The name of the operation's parent resource.", "pattern": "^endpoints/[^/]+$", "location": "path" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "The standard list page size." } }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "httpMethod": "GET", "flatPath": "v1beta1/endpoints/{endpointsId}/operations" }, "cancel": { "parameterOrder": [ "name" ], "flatPath": "v1beta1/endpoints/{endpointsId}/operations/{operationsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.endpoints.operations.cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "httpMethod": "POST", "path": "v1beta1/{+name}:cancel", "parameters": { "name": { "pattern": "^endpoints/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path", "description": "The name of the operation resource to be cancelled." } } }, "delete": { "flatPath": "v1beta1/endpoints/{endpointsId}/operations/{operationsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "location": "path", "type": "string", "description": "The name of the operation resource to be deleted.", "required": true, "pattern": "^endpoints/[^/]+/operations/[^/]+$" } }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.endpoints.operations.delete", "path": "v1beta1/{+name}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameterOrder": [ "name" ] } } } }, "methods": { "computeTokens": { "description": "Return a list of tokens based on the input text.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "endpoint" ], "path": "v1beta1/{+endpoint}:computeTokens", "id": "aiplatform.endpoints.computeTokens", "httpMethod": "POST", "parameters": { "endpoint": { "pattern": "^endpoints/[^/]+$", "location": "path", "description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", "type": "string", "required": true } }, "flatPath": "v1beta1/endpoints/{endpointsId}:computeTokens", "response": { "$ref": "GoogleCloudAiplatformV1beta1ComputeTokensResponse" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1ComputeTokensRequest" } }, "generateContent": { "response": { "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" }, "path": "v1beta1/{+model}:generateContent", "parameters": { "model": { "description": "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}`", "pattern": "^endpoints/[^/]+$", "location": "path", "type": "string", "required": true } }, "parameterOrder": [ "model" ], "httpMethod": "POST", "flatPath": "v1beta1/endpoints/{endpointsId}:generateContent", "request": { "$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" }, "description": "Generate content with multimodal inputs.", "id": "aiplatform.endpoints.generateContent", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] }, "streamGenerateContent": { "description": "Generate content with multimodal inputs with streaming support.", "response": { "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" }, "flatPath": "v1beta1/endpoints/{endpointsId}:streamGenerateContent", "parameters": { "model": { "type": "string", "required": true, "description": "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}`", "location": "path", "pattern": "^endpoints/[^/]+$" } }, "id": "aiplatform.endpoints.streamGenerateContent", "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "path": "v1beta1/{+model}:streamGenerateContent", "parameterOrder": [ "model" ] }, "predict": { "flatPath": "v1beta1/endpoints/{endpointsId}:predict", "request": { "$ref": "GoogleCloudAiplatformV1beta1PredictRequest" }, "parameters": { "endpoint": { "type": "string", "required": true, "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "pattern": "^endpoints/[^/]+$", "location": "path" } }, "parameterOrder": [ "endpoint" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1PredictResponse" }, "path": "v1beta1/{+endpoint}:predict", "id": "aiplatform.endpoints.predict", "description": "" }, "countTokens": { "description": "Perform a token counting.", "flatPath": "v1beta1/endpoints/{endpointsId}:countTokens", "response": { "$ref": "GoogleCloudAiplatformV1beta1CountTokensResponse" }, "id": "aiplatform.endpoints.countTokens", "path": "v1beta1/{+endpoint}:countTokens", "parameters": { "endpoint": { "type": "string", "pattern": "^endpoints/[^/]+$", "required": true, "location": "path", "description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1CountTokensRequest" }, "parameterOrder": [ "endpoint" ] }, "predictLongRunning": { "parameterOrder": [ "endpoint" ], "flatPath": "v1beta1/endpoints/{endpointsId}:predictLongRunning", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.endpoints.predictLongRunning", "request": { "$ref": "GoogleCloudAiplatformV1beta1PredictLongRunningRequest" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "description": "", "parameters": { "endpoint": { "description": "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}`", "type": "string", "pattern": "^endpoints/[^/]+$", "required": true, "location": "path" } }, "path": "v1beta1/{+endpoint}:predictLongRunning" }, "fetchPredictOperation": { "request": { "$ref": "GoogleCloudAiplatformV1beta1FetchPredictOperationRequest" }, "httpMethod": "POST", "parameters": { "endpoint": { "description": "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}`", "location": "path", "type": "string", "pattern": "^endpoints/[^/]+$", "required": true } }, "id": "aiplatform.endpoints.fetchPredictOperation", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Fetch an asynchronous online prediction operation.", "parameterOrder": [ "endpoint" ], "path": "v1beta1/{+endpoint}:fetchPredictOperation", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "flatPath": "v1beta1/endpoints/{endpointsId}:fetchPredictOperation" } } }, "indexes": { "resources": { "operations": { "methods": { "cancel": { "parameters": { "name": { "pattern": "^indexes/[^/]+/operations/[^/]+$", "type": "string", "required": true, "location": "path", "description": "The name of the operation resource to be cancelled." } }, "flatPath": "v1beta1/indexes/{indexesId}/operations/{operationsId}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "httpMethod": "POST", "id": "aiplatform.indexes.operations.cancel", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.indexes.operations.delete", "httpMethod": "DELETE", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "flatPath": "v1beta1/indexes/{indexesId}/operations/{operationsId}", "path": "v1beta1/{+name}", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "pattern": "^indexes/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "required": true } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "aiplatform.indexes.operations.list", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "httpMethod": "GET", "parameters": { "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "pageSize": { "type": "integer", "location": "query", "description": "The standard list page size.", "format": "int32" }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "name": { "pattern": "^indexes/[^/]+$", "location": "path", "description": "The name of the operation's parent resource.", "type": "string", "required": true }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." } }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/indexes/{indexesId}/operations" }, "get": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "httpMethod": "GET", "id": "aiplatform.indexes.operations.get", "parameters": { "name": { "pattern": "^indexes/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource.", "type": "string", "location": "path" } }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/indexes/{indexesId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" } }, "wait": { "flatPath": "v1beta1/indexes/{indexesId}/operations/{operationsId}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.indexes.operations.wait", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}:wait", "parameters": { "name": { "type": "string", "pattern": "^indexes/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to wait on.", "location": "path" }, "timeout": { "location": "query", "format": "google-duration", "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." } }, "httpMethod": "POST", "parameterOrder": [ "name" ] } } } } }, "dataLabelingJobs": { "resources": { "operations": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "required": true, "pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$", "type": "string", "location": "path" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.dataLabelingJobs.operations.get", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}" }, "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:cancel", "parameterOrder": [ "name" ], "id": "aiplatform.dataLabelingJobs.operations.cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$", "type": "string", "required": true, "location": "path" } }, "httpMethod": "POST", "flatPath": "v1beta1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel" }, "wait": { "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "aiplatform.dataLabelingJobs.operations.wait", "path": "v1beta1/{+name}:wait", "parameters": { "name": { "pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to wait on.", "type": "string", "location": "path" }, "timeout": { "location": "query", "format": "google-duration", "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." } }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "httpMethod": "POST" }, "delete": { "id": "aiplatform.dataLabelingJobs.operations.delete", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "required": true, "type": "string", "location": "path", "pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$" } }, "httpMethod": "DELETE", "flatPath": "v1beta1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "parameters": { "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "returnPartialSuccess": { "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query" }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "The standard list page size." }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "name": { "type": "string", "pattern": "^dataLabelingJobs/[^/]+$", "required": true, "description": "The name of the operation's parent resource.", "location": "path" } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "flatPath": "v1beta1/dataLabelingJobs/{dataLabelingJobsId}/operations", "path": "v1beta1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "id": "aiplatform.dataLabelingJobs.operations.list", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." } } } } }, "vertexExpress": { "methods": { "signUp": { "response": { "$ref": "GoogleCloudAiplatformV1beta1ExpressProject" }, "flatPath": "v1beta1/vertexExpress:signUp", "parameters": {}, "httpMethod": "POST", "parameterOrder": [], "request": { "$ref": "GoogleCloudAiplatformV1beta1SignUpRequest" }, "description": "Signs up the user for Vertex AI Express Mode. If the user is already signed up, the existing ExpressProject will be returned.", "path": "v1beta1/vertexExpress:signUp", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.vertexExpress.signUp" }, "retrieveExpressProject": { "path": "v1beta1/vertexExpress:retrieveExpressProject", "parameters": { "getDefaultApiKey": { "location": "query", "description": "Optional. Whether to return the default API key string in the response.", "type": "boolean" } }, "parameterOrder": [], "description": "Retrieves the project for Vertex AI Express Mode.", "httpMethod": "GET", "flatPath": "v1beta1/vertexExpress:retrieveExpressProject", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.vertexExpress.retrieveExpressProject", "response": { "$ref": "GoogleCloudAiplatformV1beta1RetrieveExpressProjectResponse" } } }, "resources": { "Eligibility": { "methods": { "check": { "httpMethod": "GET", "path": "v1beta1/vertexExpress/Eligibility:check", "parameters": {}, "id": "aiplatform.vertexExpress.Eligibility.check", "description": "Checks whether the user is eligible to sign up for Vertex AI Express Mode.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1CheckSignUpEligibilityResponse" }, "parameterOrder": [], "flatPath": "v1beta1/vertexExpress/Eligibility:check" } } } } }, "migratableResources": { "resources": { "operations": { "methods": { "delete": { "path": "v1beta1/{+name}", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "pattern": "^migratableResources/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "id": "aiplatform.migratableResources.operations.delete", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ] }, "get": { "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^migratableResources/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path" } }, "flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}", "path": "v1beta1/{+name}", "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.migratableResources.operations.get", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "wait": { "parameters": { "timeout": { "location": "query", "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string" }, "name": { "description": "The name of the operation resource to wait on.", "pattern": "^migratableResources/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path" } }, "flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait", "httpMethod": "POST", "parameterOrder": [ "name" ], "id": "aiplatform.migratableResources.operations.wait", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done." }, "cancel": { "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "location": "path", "type": "string", "description": "The name of the operation resource to be cancelled.", "required": true, "pattern": "^migratableResources/[^/]+/operations/[^/]+$" } }, "id": "aiplatform.migratableResources.operations.cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel" }, "list": { "id": "aiplatform.migratableResources.operations.list", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameterOrder": [ "name" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "pageSize": { "type": "integer", "description": "The standard list page size.", "format": "int32", "location": "query" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "name": { "pattern": "^migratableResources/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation's parent resource.", "required": true }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." } }, "path": "v1beta1/{+name}/operations", "httpMethod": "GET", "flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations" } } } } }, "servingProfiles": { "resources": { "operations": { "methods": { "delete": { "path": "v1beta1/{+name}", "parameters": { "name": { "required": true, "description": "The name of the operation resource to be deleted.", "type": "string", "location": "path", "pattern": "^servingProfiles/[^/]+/operations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "flatPath": "v1beta1/servingProfiles/{servingProfilesId}/operations/{operationsId}", "id": "aiplatform.servingProfiles.operations.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameterOrder": [ "name" ] }, "list": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "aiplatform.servingProfiles.operations.list", "httpMethod": "GET", "path": "v1beta1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameters": { "pageSize": { "description": "The standard list page size.", "type": "integer", "location": "query", "format": "int32" }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "name": { "required": true, "description": "The name of the operation's parent resource.", "type": "string", "location": "path", "pattern": "^servingProfiles/[^/]+$" } }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "flatPath": "v1beta1/servingProfiles/{servingProfilesId}/operations" }, "wait": { "flatPath": "v1beta1/servingProfiles/{servingProfilesId}/operations/{operationsId}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^servingProfiles/[^/]+/operations/[^/]+$", "type": "string", "required": true, "description": "The name of the operation resource to wait on.", "location": "path" }, "timeout": { "format": "google-duration", "type": "string", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." } }, "path": "v1beta1/{+name}:wait", "httpMethod": "POST", "id": "aiplatform.servingProfiles.operations.wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "httpMethod": "GET", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameters": { "name": { "description": "The name of the operation resource.", "required": true, "pattern": "^servingProfiles/[^/]+/operations/[^/]+$", "location": "path", "type": "string" } }, "flatPath": "v1beta1/servingProfiles/{servingProfilesId}/operations/{operationsId}", "id": "aiplatform.servingProfiles.operations.get", "path": "v1beta1/{+name}" }, "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "description": "The name of the operation resource to be cancelled.", "location": "path", "type": "string", "pattern": "^servingProfiles/[^/]+/operations/[^/]+$" } }, "httpMethod": "POST", "id": "aiplatform.servingProfiles.operations.cancel", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/servingProfiles/{servingProfilesId}/operations/{operationsId}:cancel", "path": "v1beta1/{+name}:cancel" } } } } }, "extensions": { "resources": { "operations": { "methods": { "list": { "id": "aiplatform.extensions.operations.list", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v1beta1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/extensions/{extensionsId}/operations", "httpMethod": "GET", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameters": { "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "name": { "pattern": "^extensions/[^/]+$", "required": true, "type": "string", "description": "The name of the operation's parent resource.", "location": "path" }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "pageSize": { "format": "int32", "type": "integer", "description": "The standard list page size.", "location": "query" } }, "parameterOrder": [ "name" ] }, "wait": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.extensions.operations.wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "httpMethod": "POST", "flatPath": "v1beta1/extensions/{extensionsId}/operations/{operationsId}:wait", "parameters": { "timeout": { "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration", "type": "string" }, "name": { "pattern": "^extensions/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to wait on.", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:wait" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "flatPath": "v1beta1/extensions/{extensionsId}/operations/{operationsId}", "id": "aiplatform.extensions.operations.delete", "httpMethod": "DELETE", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "required": true, "description": "The name of the operation resource to be deleted.", "type": "string", "location": "path", "pattern": "^extensions/[^/]+/operations/[^/]+$" } } }, "cancel": { "flatPath": "v1beta1/extensions/{extensionsId}/operations/{operationsId}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.extensions.operations.cancel", "httpMethod": "POST", "parameterOrder": [ "name" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameters": { "name": { "location": "path", "description": "The name of the operation resource to be cancelled.", "required": true, "type": "string", "pattern": "^extensions/[^/]+/operations/[^/]+$" } }, "path": "v1beta1/{+name}:cancel" }, "get": { "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation resource.", "location": "path", "pattern": "^extensions/[^/]+/operations/[^/]+$" } }, "parameterOrder": [ "name" ], "httpMethod": "GET", "path": "v1beta1/{+name}", "flatPath": "v1beta1/extensions/{extensionsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.extensions.operations.get", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." } } } } }, "customJobs": { "resources": { "operations": { "methods": { "get": { "flatPath": "v1beta1/customJobs/{customJobsId}/operations/{operationsId}", "httpMethod": "GET", "id": "aiplatform.customJobs.operations.get", "parameters": { "name": { "description": "The name of the operation resource.", "location": "path", "pattern": "^customJobs/[^/]+/operations/[^/]+$", "type": "string", "required": true } }, "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}/operations", "id": "aiplatform.customJobs.operations.list", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "httpMethod": "GET", "flatPath": "v1beta1/customJobs/{customJobsId}/operations", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation's parent resource.", "location": "path", "pattern": "^customJobs/[^/]+$" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "pageSize": { "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } } }, "delete": { "id": "aiplatform.customJobs.operations.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "flatPath": "v1beta1/customJobs/{customJobsId}/operations/{operationsId}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "description": "The name of the operation resource to be deleted.", "required": true, "type": "string", "pattern": "^customJobs/[^/]+/operations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "wait": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/customJobs/{customJobsId}/operations/{operationsId}:wait", "parameterOrder": [ "name" ], "id": "aiplatform.customJobs.operations.wait", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "description": "The name of the operation resource to wait on.", "pattern": "^customJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path" }, "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "location": "query", "format": "google-duration" } }, "path": "v1beta1/{+name}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done." }, "cancel": { "flatPath": "v1beta1/customJobs/{customJobsId}/operations/{operationsId}:cancel", "parameters": { "name": { "pattern": "^customJobs/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to be cancelled.", "location": "path", "type": "string" } }, "id": "aiplatform.customJobs.operations.cancel", "parameterOrder": [ "name" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "path": "v1beta1/{+name}:cancel", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" } } } } } }, "metadataStores": { "resources": { "executions": { "resources": { "operations": { "methods": { "list": { "parameterOrder": [ "name" ], "path": "v1beta1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "id": "aiplatform.metadataStores.executions.operations.list", "parameters": { "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "name": { "pattern": "^metadataStores/[^/]+/executions/[^/]+$", "location": "path", "type": "string", "required": true, "description": "The name of the operation's parent resource." }, "pageSize": { "type": "integer", "location": "query", "description": "The standard list page size.", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" } }, "flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations", "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "id": "aiplatform.metadataStores.executions.operations.get", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "required": true, "location": "path", "type": "string", "description": "The name of the operation resource." } }, "httpMethod": "GET", "flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "path": "v1beta1/{+name}" }, "wait": { "flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait", "path": "v1beta1/{+name}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameters": { "name": { "type": "string", "required": true, "description": "The name of the operation resource to wait on.", "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "location": "path" }, "timeout": { "format": "google-duration", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.metadataStores.executions.operations.wait", "parameterOrder": [ "name" ] }, "cancel": { "id": "aiplatform.metadataStores.executions.operations.cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel", "parameters": { "name": { "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be cancelled.", "location": "path", "type": "string", "required": true } }, "path": "v1beta1/{+name}:cancel", "httpMethod": "POST", "parameterOrder": [ "name" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "response": { "$ref": "GoogleProtobufEmpty" } }, "delete": { "parameterOrder": [ "name" ], "id": "aiplatform.metadataStores.executions.operations.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameters": { "name": { "location": "path", "type": "string", "description": "The name of the operation resource to be deleted.", "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "required": true } }, "path": "v1beta1/{+name}", "flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}" } } } } }, "operations": { "methods": { "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "aiplatform.metadataStores.operations.delete", "flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}", "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^metadataStores/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be deleted.", "type": "string", "required": true } }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" } }, "list": { "flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations", "parameterOrder": [ "name" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "id": "aiplatform.metadataStores.operations.list", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}/operations", "parameters": { "pageSize": { "format": "int32", "description": "The standard list page size.", "location": "query", "type": "integer" }, "name": { "description": "The name of the operation's parent resource.", "location": "path", "type": "string", "required": true, "pattern": "^metadataStores/[^/]+$" }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" } }, "httpMethod": "GET" }, "get": { "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^metadataStores/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "required": true } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "id": "aiplatform.metadataStores.operations.get" }, "cancel": { "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "path": "v1beta1/{+name}:cancel", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel", "id": "aiplatform.metadataStores.operations.cancel", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^metadataStores/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "required": true } }, "httpMethod": "POST" }, "wait": { "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:wait", "flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameters": { "timeout": { "location": "query", "type": "string", "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." }, "name": { "required": true, "description": "The name of the operation resource to wait on.", "pattern": "^metadataStores/[^/]+/operations/[^/]+$", "location": "path", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.metadataStores.operations.wait", "httpMethod": "POST" } } }, "artifacts": { "resources": { "operations": { "methods": { "delete": { "parameters": { "name": { "type": "string", "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "required": true, "location": "path" } }, "id": "aiplatform.metadataStores.artifacts.operations.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "The standard list page size." }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "name": { "type": "string", "location": "path", "description": "The name of the operation's parent resource.", "required": true, "pattern": "^metadataStores/[^/]+/artifacts/[^/]+$" } }, "httpMethod": "GET", "flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}/operations", "id": "aiplatform.metadataStores.artifacts.operations.list" }, "get": { "path": "v1beta1/{+name}", "httpMethod": "GET", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource.", "location": "path" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.metadataStores.artifacts.operations.get", "flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "wait": { "parameterOrder": [ "name" ], "httpMethod": "POST", "parameters": { "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "location": "query", "format": "google-duration" }, "name": { "required": true, "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to wait on.", "location": "path", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.metadataStores.artifacts.operations.wait", "flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait", "path": "v1beta1/{+name}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "response": { "$ref": "GoogleLongrunningOperation" } }, "cancel": { "parameterOrder": [ "name" ], "httpMethod": "POST", "path": "v1beta1/{+name}:cancel", "parameters": { "name": { "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "required": true, "type": "string", "description": "The name of the operation resource to be cancelled.", "location": "path" } }, "flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel", "id": "aiplatform.metadataStores.artifacts.operations.cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`." } } } } }, "contexts": { "resources": { "operations": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.metadataStores.contexts.operations.get", "httpMethod": "GET", "flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", "parameters": { "name": { "type": "string", "required": true, "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource." } } }, "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ], "id": "aiplatform.metadataStores.contexts.operations.cancel", "httpMethod": "POST", "parameters": { "name": { "type": "string", "required": true, "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be cancelled.", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:cancel" }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "pageSize": { "description": "The standard list page size.", "type": "integer", "format": "int32", "location": "query" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "name": { "location": "path", "description": "The name of the operation's parent resource.", "type": "string", "required": true, "pattern": "^metadataStores/[^/]+/contexts/[^/]+$" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." } }, "id": "aiplatform.metadataStores.contexts.operations.list", "path": "v1beta1/{+name}/operations", "httpMethod": "GET", "flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations" }, "wait": { "id": "aiplatform.metadataStores.contexts.operations.wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "timeout": { "format": "google-duration", "type": "string", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." }, "name": { "required": true, "type": "string", "description": "The name of the operation resource to wait on.", "location": "path", "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "path": "v1beta1/{+name}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait" }, "delete": { "httpMethod": "DELETE", "path": "v1beta1/{+name}", "parameters": { "name": { "required": true, "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", "type": "string", "location": "path", "description": "The name of the operation resource to be deleted." } }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "aiplatform.metadataStores.contexts.operations.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}" } } } } } } }, "publishers": { "resources": { "models": { "methods": { "computeTokens": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1ComputeTokensResponse" }, "id": "aiplatform.publishers.models.computeTokens", "parameters": { "endpoint": { "location": "path", "pattern": "^publishers/[^/]+/models/[^/]+$", "required": true, "description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", "type": "string" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1ComputeTokensRequest" }, "path": "v1beta1/{+endpoint}:computeTokens", "httpMethod": "POST", "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:computeTokens", "description": "Return a list of tokens based on the input text.", "parameterOrder": [ "endpoint" ] }, "generateContent": { "response": { "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" }, "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:generateContent", "id": "aiplatform.publishers.models.generateContent", "request": { "$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "path": "v1beta1/{+model}:generateContent", "description": "Generate content with multimodal inputs.", "parameters": { "model": { "required": true, "type": "string", "location": "path", "description": "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}`", "pattern": "^publishers/[^/]+/models/[^/]+$" } }, "parameterOrder": [ "model" ], "httpMethod": "POST" }, "predict": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "parameterOrder": [ "endpoint" ], "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:predict", "request": { "$ref": "GoogleCloudAiplatformV1beta1PredictRequest" }, "response": { "$ref": "GoogleCloudAiplatformV1beta1PredictResponse" }, "description": "", "parameters": { "endpoint": { "location": "path", "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "pattern": "^publishers/[^/]+/models/[^/]+$", "type": "string", "required": true } }, "id": "aiplatform.publishers.models.predict", "path": "v1beta1/{+endpoint}:predict", "httpMethod": "POST" }, "list": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "filter": { "description": "Optional. The standard list filter.", "type": "string", "location": "query" }, "orderBy": { "type": "string", "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", "location": "query" }, "listAllVersions": { "description": "Optional. List all publisher model versions if the flag is set to true.", "location": "query", "type": "boolean" }, "parent": { "required": true, "pattern": "^publishers/[^/]+$", "description": "Required. The name of the Publisher from which to list the PublisherModels. Format: `publishers/{publisher}`", "location": "path", "type": "string" }, "view": { "description": "Optional. PublisherModel view specifying which fields to read.", "enumDescriptions": [ "The default / unset value. The API will default to the BASIC view.", "Include basic metadata about the publisher model, but not the full contents.", "Include everything.", "Include: VersionId, ModelVersionExternalName, and SupportedActions." ], "enum": [ "PUBLISHER_MODEL_VIEW_UNSPECIFIED", "PUBLISHER_MODEL_VIEW_BASIC", "PUBLISHER_MODEL_VIEW_FULL", "PUBLISHER_MODEL_VERSION_VIEW_BASIC" ], "location": "query", "type": "string" }, "pageToken": { "type": "string", "location": "query", "description": "Optional. The standard list page token. Typically obtained via ListPublisherModelsResponse.next_page_token of the previous ModelGardenService.ListPublisherModels call." }, "languageCode": { "description": "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).", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. The standard list page size.", "location": "query", "type": "integer", "format": "int32" } }, "httpMethod": "GET", "id": "aiplatform.publishers.models.list", "flatPath": "v1beta1/publishers/{publishersId}/models", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListPublisherModelsResponse" }, "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/models", "description": "Lists publisher models in Model Garden." }, "countTokens": { "description": "Perform a token counting.", "parameters": { "endpoint": { "location": "path", "type": "string", "description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "required": true, "pattern": "^publishers/[^/]+/models/[^/]+$" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1CountTokensRequest" }, "httpMethod": "POST", "response": { "$ref": "GoogleCloudAiplatformV1beta1CountTokensResponse" }, "parameterOrder": [ "endpoint" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "id": "aiplatform.publishers.models.countTokens", "path": "v1beta1/{+endpoint}:countTokens", "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:countTokens" }, "fetchPredictOperation": { "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation", "request": { "$ref": "GoogleCloudAiplatformV1beta1FetchPredictOperationRequest" }, "parameters": { "endpoint": { "description": "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": true, "pattern": "^publishers/[^/]+/models/[^/]+$", "type": "string", "location": "path" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "parameterOrder": [ "endpoint" ], "id": "aiplatform.publishers.models.fetchPredictOperation", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "description": "Fetch an asynchronous online prediction operation.", "path": "v1beta1/{+endpoint}:fetchPredictOperation" }, "get": { "path": "v1beta1/{+name}", "id": "aiplatform.publishers.models.get", "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}", "description": "Gets a Model Garden publisher model.", "response": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModel" }, "httpMethod": "GET", "parameters": { "huggingFaceToken": { "location": "query", "type": "string", "description": "Optional. Token used to access Hugging Face gated models." }, "includeEquivalentModelGardenModelDeploymentConfigs": { "description": "Optional. Whether to cnclude the deployment configs from the equivalent Model Garden model if the requested model is a Hugging Face model.", "type": "boolean", "location": "query" }, "isHuggingFaceModel": { "description": "Optional. Boolean indicates whether the requested model is a Hugging Face model.", "location": "query", "type": "boolean" }, "name": { "description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`", "pattern": "^publishers/[^/]+/models/[^/]+$", "location": "path", "type": "string", "required": true }, "view": { "enum": [ "PUBLISHER_MODEL_VIEW_UNSPECIFIED", "PUBLISHER_MODEL_VIEW_BASIC", "PUBLISHER_MODEL_VIEW_FULL", "PUBLISHER_MODEL_VERSION_VIEW_BASIC" ], "location": "query", "description": "Optional. PublisherModel view specifying which fields to read.", "enumDescriptions": [ "The default / unset value. The API will default to the BASIC view.", "Include basic metadata about the publisher model, but not the full contents.", "Include everything.", "Include: VersionId, ModelVersionExternalName, and SupportedActions." ], "type": "string" }, "languageCode": { "type": "string", "description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.", "location": "query" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "predictLongRunning": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "parameters": { "endpoint": { "pattern": "^publishers/[^/]+/models/[^/]+$", "required": true, "description": "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}`", "location": "path", "type": "string" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1PredictLongRunningRequest" }, "id": "aiplatform.publishers.models.predictLongRunning", "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "endpoint" ], "path": "v1beta1/{+endpoint}:predictLongRunning", "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:predictLongRunning", "description": "" }, "streamGenerateContent": { "request": { "$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" }, "parameterOrder": [ "model" ], "description": "Generate content with multimodal inputs with streaming support.", "id": "aiplatform.publishers.models.streamGenerateContent", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "path": "v1beta1/{+model}:streamGenerateContent", "httpMethod": "POST", "parameters": { "model": { "required": true, "pattern": "^publishers/[^/]+/models/[^/]+$", "description": "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}`", "location": "path", "type": "string" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" }, "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:streamGenerateContent" } } } } }, "modelMonitors": { "resources": { "operations": { "methods": { "wait": { "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}:wait", "id": "aiplatform.modelMonitors.operations.wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the operation resource to wait on.", "pattern": "^modelMonitors/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "required": true }, "timeout": { "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration", "type": "string" } }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:wait" }, "get": { "id": "aiplatform.modelMonitors.operations.get", "path": "v1beta1/{+name}", "parameters": { "name": { "type": "string", "location": "path", "pattern": "^modelMonitors/[^/]+/operations/[^/]+$", "description": "The name of the operation resource.", "required": true } }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ], "httpMethod": "GET", "flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" } }, "delete": { "path": "v1beta1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^modelMonitors/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path", "description": "The name of the operation resource to be deleted." } }, "flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}", "id": "aiplatform.modelMonitors.operations.delete" }, "list": { "flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations", "parameters": { "name": { "type": "string", "required": true, "location": "path", "pattern": "^modelMonitors/[^/]+$", "description": "The name of the operation's parent resource." }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "The standard list page size." }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." } }, "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}/operations", "parameterOrder": [ "name" ], "id": "aiplatform.modelMonitors.operations.list" }, "cancel": { "path": "v1beta1/{+name}:cancel", "parameterOrder": [ "name" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "type": "string", "location": "path", "pattern": "^modelMonitors/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be cancelled." } }, "httpMethod": "POST", "id": "aiplatform.modelMonitors.operations.cancel", "response": { "$ref": "GoogleProtobufEmpty" } } } } } }, "featurestores": { "resources": { "operations": { "methods": { "cancel": { "flatPath": "v1beta1/featurestores/{featurestoresId}/operations/{operationsId}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "POST", "parameters": { "name": { "location": "path", "type": "string", "required": true, "description": "The name of the operation resource to be cancelled.", "pattern": "^featurestores/[^/]+/operations/[^/]+$" } }, "path": "v1beta1/{+name}:cancel", "id": "aiplatform.featurestores.operations.cancel" }, "wait": { "flatPath": "v1beta1/featurestores/{featurestoresId}/operations/{operationsId}:wait", "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "parameters": { "timeout": { "type": "string", "format": "google-duration", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." }, "name": { "type": "string", "pattern": "^featurestores/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to wait on.", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "httpMethod": "POST", "id": "aiplatform.featurestores.operations.wait" }, "get": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "description": "The name of the operation resource.", "type": "string", "required": true, "pattern": "^featurestores/[^/]+/operations/[^/]+$" } }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/featurestores/{featurestoresId}/operations/{operationsId}", "parameterOrder": [ "name" ], "id": "aiplatform.featurestores.operations.get", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}" }, "delete": { "path": "v1beta1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "httpMethod": "DELETE", "flatPath": "v1beta1/featurestores/{featurestoresId}/operations/{operationsId}", "parameters": { "name": { "type": "string", "location": "path", "pattern": "^featurestores/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "required": true } }, "id": "aiplatform.featurestores.operations.delete", "parameterOrder": [ "name" ] }, "list": { "parameters": { "name": { "pattern": "^featurestores/[^/]+$", "location": "path", "description": "The name of the operation's parent resource.", "type": "string", "required": true }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" }, "pageSize": { "description": "The standard list page size.", "format": "int32", "type": "integer", "location": "query" }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" } }, "httpMethod": "GET", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/featurestores/{featurestoresId}/operations", "path": "v1beta1/{+name}/operations", "id": "aiplatform.featurestores.operations.list", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ] } } }, "entityTypes": { "resources": { "operations": { "methods": { "delete": { "httpMethod": "DELETE", "id": "aiplatform.featurestores.entityTypes.operations.delete", "parameters": { "name": { "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "type": "string", "location": "path", "required": true } }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" } }, "cancel": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", "type": "string", "required": true } }, "flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel", "path": "v1beta1/{+name}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "id": "aiplatform.featurestores.entityTypes.operations.cancel", "parameterOrder": [ "name" ] }, "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations", "id": "aiplatform.featurestores.entityTypes.operations.list", "path": "v1beta1/{+name}/operations", "httpMethod": "GET", "parameters": { "returnPartialSuccess": { "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query" }, "pageSize": { "format": "int32", "type": "integer", "location": "query", "description": "The standard list page size." }, "name": { "pattern": "^featurestores/[^/]+/entityTypes/[^/]+$", "type": "string", "location": "path", "description": "The name of the operation's parent resource.", "required": true }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" } }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "parameters": { "name": { "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", "required": true, "type": "string", "description": "The name of the operation resource.", "location": "path" } }, "path": "v1beta1/{+name}", "httpMethod": "GET", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}", "id": "aiplatform.featurestores.entityTypes.operations.get", "response": { "$ref": "GoogleLongrunningOperation" } }, "wait": { "id": "aiplatform.featurestores.entityTypes.operations.wait", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "timeout": { "type": "string", "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query" }, "name": { "description": "The name of the operation resource to wait on.", "required": true, "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", "type": "string", "location": "path" } }, "httpMethod": "POST", "flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "path": "v1beta1/{+name}:wait" } } }, "features": { "resources": { "operations": { "methods": { "get": { "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}", "id": "aiplatform.featurestores.entityTypes.features.operations.get", "parameters": { "name": { "required": true, "description": "The name of the operation resource.", "location": "path", "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", "type": "string" } }, "httpMethod": "GET", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "cancel": { "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "required": true } }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "aiplatform.featurestores.entityTypes.features.operations.cancel", "flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel", "path": "v1beta1/{+name}:cancel" }, "delete": { "path": "v1beta1/{+name}", "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "required": true, "type": "string", "description": "The name of the operation resource to be deleted.", "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$" } }, "id": "aiplatform.featurestores.entityTypes.features.operations.delete", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "wait": { "flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait", "id": "aiplatform.featurestores.entityTypes.features.operations.wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:wait", "parameters": { "name": { "required": true, "description": "The name of the operation resource to wait on.", "type": "string", "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", "location": "path" }, "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "format": "google-duration", "type": "string" } }, "parameterOrder": [ "name" ], "httpMethod": "POST" }, "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "id": "aiplatform.featurestores.entityTypes.features.operations.list", "parameters": { "name": { "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", "location": "path", "required": true, "description": "The name of the operation's parent resource.", "type": "string" }, "returnPartialSuccess": { "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query" }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "The standard list page size." }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" } }, "httpMethod": "GET", "path": "v1beta1/{+name}/operations" } } } } } } } } }, "specialistPools": { "resources": { "operations": { "methods": { "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/specialistPools/{specialistPoolsId}/operations/{operationsId}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "path": "v1beta1/{+name}", "id": "aiplatform.specialistPools.operations.delete", "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^specialistPools/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be deleted.", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "get": { "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/specialistPools/{specialistPoolsId}/operations/{operationsId}", "id": "aiplatform.specialistPools.operations.get", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "pattern": "^specialistPools/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource.", "type": "string", "required": true } }, "httpMethod": "GET", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ] }, "wait": { "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameterOrder": [ "name" ], "id": "aiplatform.specialistPools.operations.wait", "flatPath": "v1beta1/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^specialistPools/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to wait on.", "location": "path", "type": "string", "required": true }, "timeout": { "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "format": "google-duration" } }, "path": "v1beta1/{+name}:wait" }, "list": { "parameters": { "name": { "type": "string", "pattern": "^specialistPools/[^/]+$", "location": "path", "description": "The name of the operation's parent resource.", "required": true }, "pageSize": { "format": "int32", "description": "The standard list page size.", "type": "integer", "location": "query" }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "httpMethod": "GET", "flatPath": "v1beta1/specialistPools/{specialistPoolsId}/operations", "id": "aiplatform.specialistPools.operations.list", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v1beta1/{+name}/operations", "parameterOrder": [ "name" ] }, "cancel": { "parameterOrder": [ "name" ], "id": "aiplatform.specialistPools.operations.cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "path": "v1beta1/{+name}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "POST", "flatPath": "v1beta1/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^specialistPools/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be cancelled." } } } } } } }, "featureGroups": { "resources": { "features": { "resources": { "operations": { "methods": { "wait": { "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.featureGroups.features.operations.wait", "path": "v1beta1/{+name}:wait", "flatPath": "v1beta1/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait", "parameterOrder": [ "name" ], "parameters": { "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string", "location": "query", "format": "google-duration" }, "name": { "location": "path", "type": "string", "description": "The name of the operation resource to wait on.", "pattern": "^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", "required": true } }, "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST" }, "delete": { "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "required": true, "pattern": "^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", "location": "path", "type": "string" } }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.featureGroups.features.operations.delete", "flatPath": "v1beta1/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", "parameterOrder": [ "name" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}" }, "get": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "name": { "required": true, "location": "path", "type": "string", "pattern": "^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", "description": "The name of the operation resource." } }, "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "id": "aiplatform.featureGroups.features.operations.get", "flatPath": "v1beta1/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}" }, "list": { "httpMethod": "GET", "parameters": { "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "name": { "location": "path", "description": "The name of the operation's parent resource.", "type": "string", "required": true, "pattern": "^featureGroups/[^/]+/features/[^/]+$" }, "pageSize": { "format": "int32", "description": "The standard list page size.", "location": "query", "type": "integer" }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." } }, "id": "aiplatform.featureGroups.features.operations.list", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v1beta1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "flatPath": "v1beta1/featureGroups/{featureGroupsId}/features/{featuresId}/operations" } } } } }, "operations": { "methods": { "wait": { "parameters": { "name": { "pattern": "^featureGroups/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to wait on.", "required": true, "type": "string" }, "timeout": { "location": "query", "type": "string", "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." } }, "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "httpMethod": "POST", "id": "aiplatform.featureGroups.operations.wait", "flatPath": "v1beta1/featureGroups/{featureGroupsId}/operations/{operationsId}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "path": "v1beta1/{+name}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "id": "aiplatform.featureGroups.operations.get", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/featureGroups/{featureGroupsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "pattern": "^featureGroups/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource.", "location": "path", "type": "string" } }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" } }, "delete": { "flatPath": "v1beta1/featureGroups/{featureGroupsId}/operations/{operationsId}", "path": "v1beta1/{+name}", "id": "aiplatform.featureGroups.operations.delete", "httpMethod": "DELETE", "parameters": { "name": { "required": true, "type": "string", "location": "path", "pattern": "^featureGroups/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted." } }, "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameterOrder": [ "name" ] }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.featureGroups.operations.list", "path": "v1beta1/{+name}/operations", "httpMethod": "GET", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameters": { "filter": { "type": "string", "description": "The standard list filter.", "location": "query" }, "pageSize": { "location": "query", "description": "The standard list page size.", "format": "int32", "type": "integer" }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" }, "name": { "pattern": "^featureGroups/[^/]+$", "location": "path", "type": "string", "required": true, "description": "The name of the operation's parent resource." }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" } }, "flatPath": "v1beta1/featureGroups/{featureGroupsId}/operations", "parameterOrder": [ "name" ] } } }, "featureMonitors": { "resources": { "operations": { "methods": { "list": { "parameters": { "name": { "required": true, "type": "string", "location": "path", "description": "The name of the operation's parent resource.", "pattern": "^featureGroups/[^/]+/featureMonitors/[^/]+$" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "returnPartialSuccess": { "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query" }, "pageSize": { "format": "int32", "description": "The standard list page size.", "type": "integer", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." } }, "path": "v1beta1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "flatPath": "v1beta1/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "id": "aiplatform.featureGroups.featureMonitors.operations.list", "parameterOrder": [ "name" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "flatPath": "v1beta1/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}", "parameters": { "name": { "pattern": "^featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$", "description": "The name of the operation resource.", "required": true, "type": "string", "location": "path" } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "path": "v1beta1/{+name}", "id": "aiplatform.featureGroups.featureMonitors.operations.get", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "id": "aiplatform.featureGroups.featureMonitors.operations.delete", "flatPath": "v1beta1/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}", "path": "v1beta1/{+name}", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "location": "path", "type": "string", "description": "The name of the operation resource to be deleted.", "required": true, "pattern": "^featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$" } } }, "wait": { "path": "v1beta1/{+name}:wait", "parameterOrder": [ "name" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "id": "aiplatform.featureGroups.featureMonitors.operations.wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "timeout": { "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration", "location": "query" }, "name": { "location": "path", "type": "string", "required": true, "pattern": "^featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to wait on." } }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "flatPath": "v1beta1/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}:wait" } } } } } } }, "apps": { "resources": { "operations": { "methods": { "delete": { "httpMethod": "DELETE", "parameters": { "name": { "required": true, "location": "path", "type": "string", "description": "The name of the operation resource to be deleted.", "pattern": "^apps/[^/]+/operations/[^/]+$" } }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/apps/{appsId}/operations/{operationsId}", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "id": "aiplatform.apps.operations.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/apps/{appsId}/operations/{operationsId}", "id": "aiplatform.apps.operations.get", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "parameters": { "name": { "pattern": "^apps/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path", "description": "The name of the operation resource." } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET" }, "wait": { "parameters": { "name": { "type": "string", "pattern": "^apps/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to wait on.", "location": "path" }, "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "type": "string", "format": "google-duration" } }, "path": "v1beta1/{+name}:wait", "httpMethod": "POST", "flatPath": "v1beta1/apps/{appsId}/operations/{operationsId}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameterOrder": [ "name" ], "id": "aiplatform.apps.operations.wait" }, "cancel": { "httpMethod": "POST", "parameters": { "name": { "required": true, "type": "string", "location": "path", "description": "The name of the operation resource to be cancelled.", "pattern": "^apps/[^/]+/operations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.apps.operations.cancel", "path": "v1beta1/{+name}:cancel", "parameterOrder": [ "name" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1beta1/apps/{appsId}/operations/{operationsId}:cancel" }, "list": { "id": "aiplatform.apps.operations.list", "parameters": { "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "pageSize": { "type": "integer", "location": "query", "description": "The standard list page size.", "format": "int32" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "name": { "location": "path", "pattern": "^apps/[^/]+$", "required": true, "type": "string", "description": "The name of the operation's parent resource." } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "path": "v1beta1/{+name}/operations", "flatPath": "v1beta1/apps/{appsId}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "response": { "$ref": "GoogleLongrunningListOperationsResponse" } } } } } }, "modelDeploymentMonitoringJobs": { "resources": { "operations": { "methods": { "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "required": true, "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource to be deleted.", "location": "path" } }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "httpMethod": "DELETE", "id": "aiplatform.modelDeploymentMonitoringJobs.operations.delete", "flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}" }, "get": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "The name of the operation resource.", "type": "string", "location": "path", "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "required": true } }, "id": "aiplatform.modelDeploymentMonitoringJobs.operations.get", "httpMethod": "GET", "flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "wait": { "flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.modelDeploymentMonitoringJobs.operations.wait", "httpMethod": "POST", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameters": { "name": { "location": "path", "description": "The name of the operation resource to wait on.", "required": true, "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "type": "string" }, "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration", "type": "string", "location": "query" } }, "path": "v1beta1/{+name}:wait", "parameterOrder": [ "name" ] }, "cancel": { "flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "httpMethod": "POST", "parameters": { "name": { "required": true, "type": "string", "location": "path", "description": "The name of the operation resource to be cancelled.", "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$" } }, "id": "aiplatform.modelDeploymentMonitoringJobs.operations.cancel", "parameterOrder": [ "name" ] }, "list": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "id": "aiplatform.modelDeploymentMonitoringJobs.operations.list", "parameters": { "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "name": { "pattern": "^modelDeploymentMonitoringJobs/[^/]+$", "description": "The name of the operation's parent resource.", "location": "path", "required": true, "type": "string" }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "pageSize": { "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." } }, "httpMethod": "GET", "parameterOrder": [ "name" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v1beta1/{+name}/operations" } } } } }, "reasoningEngines": { "resources": { "feedbackEntries": { "resources": { "operations": { "methods": { "get": { "httpMethod": "GET", "parameterOrder": [ "name" ], "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations/{operationsId}", "parameters": { "name": { "pattern": "^reasoningEngines/[^/]+/feedbackEntries/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource.", "required": true, "type": "string" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "id": "aiplatform.reasoningEngines.feedbackEntries.operations.get", "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "wait": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.reasoningEngines.feedbackEntries.operations.wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "httpMethod": "POST", "parameters": { "timeout": { "format": "google-duration", "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query" }, "name": { "location": "path", "pattern": "^reasoningEngines/[^/]+/feedbackEntries/[^/]+/operations/[^/]+$", "type": "string", "required": true, "description": "The name of the operation resource to wait on." } }, "path": "v1beta1/{+name}:wait", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations/{operationsId}:wait", "response": { "$ref": "GoogleLongrunningOperation" } }, "delete": { "id": "aiplatform.reasoningEngines.feedbackEntries.operations.delete", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "pattern": "^reasoningEngines/[^/]+/feedbackEntries/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to be deleted.", "location": "path" } }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations/{operationsId}", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" } }, "list": { "path": "v1beta1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "parameters": { "pageSize": { "type": "integer", "location": "query", "description": "The standard list page size.", "format": "int32" }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "name": { "description": "The name of the operation's parent resource.", "pattern": "^reasoningEngines/[^/]+/feedbackEntries/[^/]+$", "location": "path", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "id": "aiplatform.reasoningEngines.feedbackEntries.operations.list" }, "cancel": { "parameters": { "name": { "required": true, "description": "The name of the operation resource to be cancelled.", "location": "path", "pattern": "^reasoningEngines/[^/]+/feedbackEntries/[^/]+/operations/[^/]+$", "type": "string" } }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations/{operationsId}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "httpMethod": "POST", "path": "v1beta1/{+name}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.reasoningEngines.feedbackEntries.operations.cancel", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } } } } }, "runtimeRevisions": { "resources": { "a2a": { "methods": { "tasks": { "httpMethod": "GET", "parameters": { "a2aEndpoint": { "location": "path", "required": true, "type": "string", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "pattern": "^tasks$" }, "name": { "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "type": "string", "required": true, "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path" }, "historyLength": { "location": "query", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "type": "string" } }, "id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.tasks", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "parameterOrder": [ "name", "a2aEndpoint" ], "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks" }, "extendedAgentCard": { "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.extendedAgentCard", "parameterOrder": [ "name", "a2aEndpoint" ], "parameters": { "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", "type": "string", "required": true, "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$" }, "a2aEndpoint": { "pattern": "^extendedAgentCard$", "required": true, "location": "path", "type": "string", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`" }, "historyLength": { "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "location": "query", "type": "string" } }, "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "httpMethod": "GET", "response": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/extendedAgentCard" }, "card": { "response": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.card", "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/card", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "a2aEndpoint": { "required": true, "type": "string", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "location": "path", "pattern": "^card$" }, "historyLength": { "type": "string", "location": "query", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned." }, "name": { "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", "type": "string" } }, "httpMethod": "GET", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "parameterOrder": [ "name", "a2aEndpoint" ] } }, "resources": { "tasks": { "resources": { "pushNotificationConfigs": { "methods": { "a2aGetReasoningEngine": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "parameterOrder": [ "name", "a2aEndpoint" ], "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", "parameters": { "a2aEndpoint": { "type": "string", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "pattern": "^tasks/[^/]+/pushNotificationConfigs/[^/]+$", "required": true, "location": "path" }, "name": { "required": true, "type": "string", "location": "path", "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`" }, "historyLength": { "location": "query", "type": "string", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned." } }, "httpMethod": "GET", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.tasks.pushNotificationConfigs.a2aGetReasoningEngine" } } } }, "methods": { "pushNotificationConfigs": { "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.tasks.pushNotificationConfigs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "parameterOrder": [ "name", "a2aEndpoint" ], "httpMethod": "GET", "parameters": { "a2aEndpoint": { "type": "string", "location": "path", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "required": true, "pattern": "^tasks/[^/]+/pushNotificationConfigs$" }, "historyLength": { "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "type": "string", "location": "query" }, "name": { "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string", "location": "path" } }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}/pushNotificationConfigs" }, "a2aGetReasoningEngine": { "httpMethod": "GET", "id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.tasks.a2aGetReasoningEngine", "parameters": { "historyLength": { "location": "query", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "type": "string" }, "name": { "type": "string", "required": true, "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path" }, "a2aEndpoint": { "required": true, "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "pattern": "^tasks/[^/]+$", "location": "path", "type": "string" } }, "parameterOrder": [ "name", "a2aEndpoint" ], "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}", "response": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" } }, "cancel": { "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.tasks.cancel", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}:cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "parameterOrder": [ "name", "a2aEndpoint" ], "parameters": { "name": { "type": "string", "required": true, "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "location": "path", "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$" }, "a2aEndpoint": { "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", "pattern": "^tasks/[^/]+$", "location": "path", "type": "string", "required": true } }, "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel", "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", "httpMethod": "POST" }, "subscribe": { "response": { "$ref": "GoogleApiHttpBody" }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}:subscribe", "description": "Stream get request for reasoning engine instance via the A2A stream get protocol apis.", "parameters": { "a2aEndpoint": { "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.", "type": "string", "required": true, "pattern": "^tasks/[^/]+$", "location": "path" }, "name": { "type": "string", "location": "path", "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true } }, "id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.tasks.subscribe", "parameterOrder": [ "name", "a2aEndpoint" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe" } } }, "v1": { "resources": { "tasks": { "resources": { "pushNotificationConfigs": { "methods": { "a2aGetReasoningEngine": { "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.tasks.pushNotificationConfigs.a2aGetReasoningEngine", "parameters": { "historyLength": { "location": "query", "type": "string", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned." }, "a2aEndpoint": { "location": "path", "pattern": "^v1/tasks/[^/]+/pushNotificationConfigs/[^/]+$", "type": "string", "required": true, "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`" }, "name": { "location": "path", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string", "required": true, "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$" } }, "httpMethod": "GET", "parameterOrder": [ "name", "a2aEndpoint" ] } } } }, "methods": { "a2aGetReasoningEngine": { "httpMethod": "GET", "parameters": { "historyLength": { "location": "query", "type": "string", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned." }, "name": { "required": true, "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string", "location": "path", "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$" }, "a2aEndpoint": { "required": true, "type": "string", "location": "path", "pattern": "^v1/tasks/[^/]+$", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`" } }, "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.tasks.a2aGetReasoningEngine", "response": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "parameterOrder": [ "name", "a2aEndpoint" ] }, "subscribe": { "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}:subscribe", "id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.tasks.subscribe", "response": { "$ref": "GoogleApiHttpBody" }, "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe", "httpMethod": "GET", "description": "Stream get request for reasoning engine instance via the A2A stream get protocol apis.", "parameters": { "a2aEndpoint": { "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.", "pattern": "^v1/tasks/[^/]+$", "required": true, "type": "string", "location": "path" }, "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "type": "string", "location": "path", "required": true } }, "parameterOrder": [ "name", "a2aEndpoint" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "cancel": { "request": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "required": true, "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "type": "string", "location": "path" }, "a2aEndpoint": { "required": true, "type": "string", "pattern": "^v1/tasks/[^/]+$", "location": "path", "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send" } }, "id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.tasks.cancel", "response": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}:cancel", "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", "parameterOrder": [ "name", "a2aEndpoint" ], "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel" }, "pushNotificationConfigs": { "response": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs", "parameters": { "historyLength": { "type": "string", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "location": "query" }, "a2aEndpoint": { "type": "string", "required": true, "location": "path", "pattern": "^v1/tasks/[^/]+/pushNotificationConfigs$", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`" }, "name": { "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "type": "string", "location": "path", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.tasks.pushNotificationConfigs", "parameterOrder": [ "name", "a2aEndpoint" ], "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}" } } }, "message": { "methods": { "stream": { "id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.message.stream", "parameters": { "a2aEndpoint": { "location": "path", "type": "string", "description": "Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.", "required": true, "pattern": "^v1/message$" }, "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "type": "string", "location": "path", "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true } }, "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:stream", "httpMethod": "POST", "response": { "$ref": "GoogleApiHttpBody" }, "parameterOrder": [ "name", "a2aEndpoint" ], "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/message:stream", "request": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "description": "Streams queries using a reasoning engine instance via the A2A streaming protocol apis.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "send": { "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", "id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.message.send", "parameterOrder": [ "name", "a2aEndpoint" ], "httpMethod": "POST", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/message:send", "parameters": { "name": { "location": "path", "type": "string", "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "required": true, "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$" }, "a2aEndpoint": { "pattern": "^v1/message$", "type": "string", "required": true, "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", "location": "path" } }, "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:send", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } } } }, "methods": { "card": { "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.card", "parameterOrder": [ "name", "a2aEndpoint" ], "parameters": { "a2aEndpoint": { "type": "string", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "pattern": "^v1/card$", "required": true, "location": "path" }, "historyLength": { "location": "query", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "type": "string" }, "name": { "type": "string", "location": "path", "required": true, "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$" } }, "httpMethod": "GET", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/card", "response": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } } }, "extendedAgentCard": { "id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.extendedAgentCard", "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "httpMethod": "GET", "response": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "parameters": { "historyLength": { "location": "query", "type": "string", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned." }, "name": { "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path" }, "a2aEndpoint": { "location": "path", "pattern": "^v1/extendedAgentCard$", "required": true, "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "type": "string" } }, "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/extendedAgentCard", "parameterOrder": [ "name", "a2aEndpoint" ] }, "tasks": { "parameters": { "a2aEndpoint": { "type": "string", "required": true, "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "pattern": "^v1/tasks$", "location": "path" }, "name": { "type": "string", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", "required": true, "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$" }, "historyLength": { "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "location": "query", "type": "string" } }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "parameterOrder": [ "name", "a2aEndpoint" ], "id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.tasks", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}" } } }, "message": { "methods": { "send": { "parameterOrder": [ "name", "a2aEndpoint" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", "request": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/message:send", "id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.message.send", "httpMethod": "POST", "response": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:send", "parameters": { "name": { "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "location": "path", "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "type": "string", "required": true }, "a2aEndpoint": { "required": true, "type": "string", "location": "path", "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", "pattern": "^message$" } } }, "stream": { "id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.message.stream", "parameters": { "a2aEndpoint": { "location": "path", "type": "string", "required": true, "description": "Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.", "pattern": "^message$" }, "name": { "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The full resource path of the reasoning engine, captured from the URL." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/message:stream", "httpMethod": "POST", "response": { "$ref": "GoogleApiHttpBody" }, "description": "Streams queries using a reasoning engine instance via the A2A streaming protocol apis.", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:stream", "request": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "parameterOrder": [ "name", "a2aEndpoint" ] } } } } }, "operations": { "methods": { "list": { "httpMethod": "GET", "parameters": { "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "location": "query", "description": "The standard list page size.", "format": "int32", "type": "integer" }, "name": { "required": true, "location": "path", "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "description": "The name of the operation's parent resource.", "type": "string" }, "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" } }, "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "aiplatform.reasoningEngines.runtimeRevisions.operations.list", "path": "v1beta1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.reasoningEngines.runtimeRevisions.operations.delete", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}", "parameters": { "name": { "type": "string", "required": true, "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be deleted." } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "path": "v1beta1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" } }, "wait": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameterOrder": [ "name" ], "httpMethod": "POST", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}:wait", "parameters": { "name": { "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to wait on.", "location": "path", "type": "string", "required": true }, "timeout": { "type": "string", "location": "query", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration" } }, "id": "aiplatform.reasoningEngines.runtimeRevisions.operations.wait", "response": { "$ref": "GoogleLongrunningOperation" } }, "get": { "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}", "httpMethod": "GET", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameters": { "name": { "type": "string", "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", "description": "The name of the operation resource.", "location": "path", "required": true } }, "id": "aiplatform.reasoningEngines.runtimeRevisions.operations.get", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "cancel": { "path": "v1beta1/{+name}:cancel", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.reasoningEngines.runtimeRevisions.operations.cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", "required": true, "type": "string", "location": "path" } } } } } }, "methods": { "streamQuery": { "path": "v1beta1/{+name}:streamQuery", "id": "aiplatform.reasoningEngines.runtimeRevisions.streamQuery", "description": "Streams queries using a reasoning engine.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1StreamQueryReasoningEngineRequest" }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}:streamQuery", "parameters": { "name": { "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path" } }, "response": { "$ref": "GoogleApiHttpBody" }, "parameterOrder": [ "name" ], "httpMethod": "POST" }, "query": { "id": "aiplatform.reasoningEngines.runtimeRevisions.query", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}:query", "request": { "$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineRequest" }, "parameterOrder": [ "name" ], "description": "Queries using a reasoning engine.", "path": "v1beta1/{+name}:query", "response": { "$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineResponse" }, "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true, "type": "string", "location": "path", "pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$" } } } } }, "examples": { "resources": { "operations": { "methods": { "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}", "id": "aiplatform.reasoningEngines.examples.operations.delete", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "path": "v1beta1/{+name}", "parameters": { "name": { "pattern": "^reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be deleted.", "type": "string", "required": true } }, "httpMethod": "DELETE" }, "cancel": { "id": "aiplatform.reasoningEngines.examples.operations.cancel", "path": "v1beta1/{+name}:cancel", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", "pattern": "^reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "httpMethod": "POST" }, "wait": { "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to wait on.", "pattern": "^reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "required": true }, "timeout": { "type": "string", "location": "query", "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." } }, "id": "aiplatform.reasoningEngines.examples.operations.wait", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}:wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "path": "v1beta1/{+name}:wait", "parameterOrder": [ "name" ] }, "get": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.reasoningEngines.examples.operations.get", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "required": true } }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "path": "v1beta1/{+name}", "httpMethod": "GET" } } } } }, "sessions": { "methods": { "list": { "parameterOrder": [ "parent" ], "id": "aiplatform.reasoningEngines.sessions.list", "path": "v1beta1/{+parent}/sessions", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions", "httpMethod": "GET", "parameters": { "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, the default page size is 100. Values greater than 100 will be capped at 100." }, "parent": { "type": "string", "pattern": "^reasoningEngines/[^/]+$", "required": true, "description": "Required. The resource name of the location to list sessions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path" }, "pageToken": { "location": "query", "description": "Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.", "type": "string" }, "filter": { "type": "string", "description": "Optional. The standard list filter. Supported fields: * `display_name` * `user_id` * `labels` Example: `display_name=\"abc\"`, `user_id=\"123\"`, `labels.key=\"value\"`.", "location": "query" }, "orderBy": { "location": "query", "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Sessions in a given reasoning engine.", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListSessionsResponse" } }, "create": { "request": { "$ref": "GoogleCloudAiplatformV1beta1Session" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "sessionId": { "description": "Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first and last characters must be a letter or number.", "location": "query", "type": "string" }, "parent": { "pattern": "^reasoningEngines/[^/]+$", "location": "path", "type": "string", "description": "Required. The resource name of the location to create the session in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true } }, "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+parent}/sessions", "httpMethod": "POST", "description": "Creates a new Session.", "parameterOrder": [ "parent" ], "id": "aiplatform.reasoningEngines.sessions.create", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions" }, "appendEvent": { "path": "v1beta1/{+name}:appendEvent", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}:appendEvent", "response": { "$ref": "GoogleCloudAiplatformV1beta1AppendEventResponse" }, "httpMethod": "POST", "description": "Appends an event to a given session.", "parameters": { "name": { "description": "Required. The resource name of the session to append event to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", "required": true, "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$", "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1SessionEvent" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.reasoningEngines.sessions.appendEvent" }, "patch": { "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", "description": "Updates the specific Session.", "response": { "$ref": "GoogleCloudAiplatformV1beta1Session" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "required": true, "description": "Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.", "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$", "type": "string", "location": "path" }, "updateMask": { "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "id": "aiplatform.reasoningEngines.sessions.patch", "path": "v1beta1/{+name}", "httpMethod": "PATCH", "request": { "$ref": "GoogleCloudAiplatformV1beta1Session" } }, "get": { "description": "Gets details of the specific Session.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1Session" }, "path": "v1beta1/{+name}", "parameters": { "name": { "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$", "type": "string", "required": true, "description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", "location": "path" } }, "parameterOrder": [ "name" ], "httpMethod": "GET", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", "id": "aiplatform.reasoningEngines.sessions.get" }, "delete": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$", "description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", "required": true, "location": "path", "type": "string" } }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", "description": "Deletes details of the specific Session.", "httpMethod": "DELETE", "id": "aiplatform.reasoningEngines.sessions.delete", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}" } }, "resources": { "events": { "methods": { "list": { "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/events", "id": "aiplatform.reasoningEngines.sessions.events.list", "path": "v1beta1/{+parent}/events", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListEventsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Events in a given session.", "parameters": { "filter": { "location": "query", "type": "string", "description": "Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp\u003e=\"2025-01-31T11:30:00-04:00\"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160)." }, "orderBy": { "location": "query", "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `timestamp` Example: `timestamp desc`.", "type": "string" }, "pageToken": { "description": "Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.", "type": "string", "location": "query" }, "parent": { "description": "Required. The resource name of the session to list events from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$", "required": true, "type": "string", "location": "path" }, "pageSize": { "description": "Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order.", "location": "query", "format": "int32", "type": "integer" } }, "parameterOrder": [ "parent" ], "httpMethod": "GET" } } }, "operations": { "methods": { "wait": { "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.reasoningEngines.sessions.operations.wait", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameters": { "timeout": { "location": "query", "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "type": "string" }, "name": { "type": "string", "required": true, "description": "The name of the operation resource to wait on.", "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", "location": "path" } }, "parameterOrder": [ "name" ], "httpMethod": "POST" }, "cancel": { "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:cancel", "parameters": { "name": { "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to be cancelled.", "type": "string", "location": "path" } }, "httpMethod": "POST", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "id": "aiplatform.reasoningEngines.sessions.operations.cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "path": "v1beta1/{+name}:cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations", "httpMethod": "GET", "parameters": { "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "pageSize": { "type": "integer", "format": "int32", "location": "query", "description": "The standard list page size." }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "name": { "location": "path", "type": "string", "required": true, "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$", "description": "The name of the operation's parent resource." }, "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." } }, "path": "v1beta1/{+name}/operations", "id": "aiplatform.reasoningEngines.sessions.operations.list", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "location": "path", "required": true, "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource." } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.reasoningEngines.sessions.operations.get", "parameterOrder": [ "name" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "delete": { "httpMethod": "DELETE", "parameters": { "name": { "type": "string", "location": "path", "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}", "id": "aiplatform.reasoningEngines.sessions.operations.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "path": "v1beta1/{+name}" } } } } }, "sandboxEnvironmentSnapshots": { "methods": { "delete": { "description": "Deletes the specific SandboxEnvironmentSnapshot.", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}", "parameters": { "name": { "type": "string", "required": true, "description": "Required. The resource name of the SandboxEnvironmentSnapshot to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`", "location": "path", "pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$" } }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.delete" }, "get": { "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of the specific SandboxEnvironmentSnapshot.", "parameters": { "name": { "location": "path", "pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$", "required": true, "type": "string", "description": "Required. The resource name of the sandbox environment snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentSnapshot" }, "httpMethod": "GET", "id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.get", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ] }, "list": { "httpMethod": "GET", "description": "Lists SandboxEnvironmentSnapshots in a given reasoning engine.", "path": "v1beta1/{+parent}/sandboxEnvironmentSnapshots", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "pattern": "^reasoningEngines/[^/]+$", "required": true, "description": "Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", "type": "string" }, "filter": { "location": "query", "type": "string", "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160)." }, "pageSize": { "format": "int32", "description": "Optional. The maximum number of SandboxEnvironmentSnapshots to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentSnapshots will be returned. Values above 100 will be coerced to 100.", "location": "query", "type": "integer" }, "pageToken": { "description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironmentSnapshots` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentSnapshotsResponse" }, "id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.list", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots" } }, "resources": { "operations": { "methods": { "wait": { "httpMethod": "POST", "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "timeout": { "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration", "location": "query" }, "name": { "pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to wait on.", "type": "string", "required": true } }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}:wait", "id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.wait", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done." }, "cancel": { "path": "v1beta1/{+name}:cancel", "httpMethod": "POST", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "location": "path", "description": "The name of the operation resource to be cancelled.", "pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", "required": true } }, "id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}:cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "httpMethod": "GET", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}", "parameters": { "name": { "pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource.", "type": "string", "required": true } }, "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "path": "v1beta1/{+name}", "id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.get" }, "list": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.list", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1beta1/{+name}/operations", "parameters": { "filter": { "location": "query", "description": "The standard list filter.", "type": "string" }, "returnPartialSuccess": { "type": "boolean", "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "pageSize": { "location": "query", "description": "The standard list page size.", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "name": { "type": "string", "pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$", "location": "path", "required": true, "description": "The name of the operation's parent resource." } }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations", "httpMethod": "GET" }, "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.delete", "path": "v1beta1/{+name}", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", "type": "string", "location": "path", "description": "The name of the operation resource to be deleted.", "required": true } } } } } } }, "a2a": { "methods": { "card": { "id": "aiplatform.reasoningEngines.a2a.card", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/card", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "parameterOrder": [ "name", "a2aEndpoint" ], "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "parameters": { "historyLength": { "location": "query", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "type": "string" }, "a2aEndpoint": { "required": true, "pattern": "^card$", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "type": "string", "location": "path" }, "name": { "pattern": "^reasoningEngines/[^/]+$", "location": "path", "type": "string", "required": true, "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`" } }, "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "httpMethod": "GET" }, "extendedAgentCard": { "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "parameters": { "historyLength": { "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "type": "string", "location": "query" }, "a2aEndpoint": { "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "pattern": "^extendedAgentCard$", "type": "string", "required": true, "location": "path" }, "name": { "location": "path", "type": "string", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "pattern": "^reasoningEngines/[^/]+$", "required": true } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name", "a2aEndpoint" ], "id": "aiplatform.reasoningEngines.a2a.extendedAgentCard", "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/extendedAgentCard" }, "tasks": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.reasoningEngines.a2a.tasks", "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/tasks", "parameters": { "a2aEndpoint": { "required": true, "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "location": "path", "type": "string", "pattern": "^tasks$" }, "historyLength": { "type": "string", "location": "query", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned." }, "name": { "location": "path", "type": "string", "pattern": "^reasoningEngines/[^/]+$", "required": true, "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`" } }, "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "httpMethod": "GET", "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "parameterOrder": [ "name", "a2aEndpoint" ] } }, "resources": { "message": { "methods": { "send": { "parameterOrder": [ "name", "a2aEndpoint" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/message:send", "response": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "parameters": { "a2aEndpoint": { "pattern": "^message$", "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", "required": true, "type": "string", "location": "path" }, "name": { "location": "path", "type": "string", "required": true, "pattern": "^reasoningEngines/[^/]+$", "description": "Required. The full resource path of the reasoning engine, captured from the URL." } }, "httpMethod": "POST", "request": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", "id": "aiplatform.reasoningEngines.a2a.message.send", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:send" }, "stream": { "httpMethod": "POST", "parameterOrder": [ "name", "a2aEndpoint" ], "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/message:stream", "parameters": { "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "location": "path", "type": "string", "required": true, "pattern": "^reasoningEngines/[^/]+$" }, "a2aEndpoint": { "type": "string", "pattern": "^message$", "required": true, "location": "path", "description": "Required. The http endpoint extracted from the URL path. e.g., v1/message:stream." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleApiHttpBody" }, "description": "Streams queries using a reasoning engine instance via the A2A streaming protocol apis.", "id": "aiplatform.reasoningEngines.a2a.message.stream", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:stream", "request": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } } }, "tasks": { "methods": { "a2aGetReasoningEngine": { "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "id": "aiplatform.reasoningEngines.a2a.tasks.a2aGetReasoningEngine", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}", "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "parameterOrder": [ "name", "a2aEndpoint" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "a2aEndpoint": { "pattern": "^tasks/[^/]+$", "type": "string", "location": "path", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "required": true }, "historyLength": { "location": "query", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "type": "string" }, "name": { "type": "string", "pattern": "^reasoningEngines/[^/]+$", "required": true, "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path" } } }, "cancel": { "parameterOrder": [ "name", "a2aEndpoint" ], "id": "aiplatform.reasoningEngines.a2a.tasks.cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}:cancel", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel", "parameters": { "name": { "location": "path", "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "required": true, "type": "string", "pattern": "^reasoningEngines/[^/]+$" }, "a2aEndpoint": { "required": true, "location": "path", "type": "string", "pattern": "^tasks/[^/]+$", "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send" } }, "request": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", "response": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" } }, "pushNotificationConfigs": { "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "parameterOrder": [ "name", "a2aEndpoint" ], "response": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "historyLength": { "location": "query", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "type": "string" }, "a2aEndpoint": { "type": "string", "pattern": "^tasks/[^/]+/pushNotificationConfigs$", "location": "path", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "required": true }, "name": { "location": "path", "pattern": "^reasoningEngines/[^/]+$", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string", "required": true } }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}/pushNotificationConfigs", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "httpMethod": "GET", "id": "aiplatform.reasoningEngines.a2a.tasks.pushNotificationConfigs" }, "subscribe": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Stream get request for reasoning engine instance via the A2A stream get protocol apis.", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}:subscribe", "response": { "$ref": "GoogleApiHttpBody" }, "parameters": { "name": { "location": "path", "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "pattern": "^reasoningEngines/[^/]+$", "required": true, "type": "string" }, "a2aEndpoint": { "location": "path", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.", "required": true, "pattern": "^tasks/[^/]+$", "type": "string" } }, "httpMethod": "GET", "parameterOrder": [ "name", "a2aEndpoint" ], "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe", "id": "aiplatform.reasoningEngines.a2a.tasks.subscribe" } }, "resources": { "pushNotificationConfigs": { "methods": { "a2aGetReasoningEngine": { "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", "httpMethod": "GET", "parameters": { "name": { "pattern": "^reasoningEngines/[^/]+$", "location": "path", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true, "type": "string" }, "historyLength": { "location": "query", "type": "string", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned." }, "a2aEndpoint": { "type": "string", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "required": true, "pattern": "^tasks/[^/]+/pushNotificationConfigs/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "parameterOrder": [ "name", "a2aEndpoint" ], "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "id": "aiplatform.reasoningEngines.a2a.tasks.pushNotificationConfigs.a2aGetReasoningEngine" } } } } }, "v1": { "methods": { "extendedAgentCard": { "parameters": { "a2aEndpoint": { "required": true, "pattern": "^v1/extendedAgentCard$", "type": "string", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "location": "path" }, "name": { "type": "string", "required": true, "location": "path", "pattern": "^reasoningEngines/[^/]+$", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`" }, "historyLength": { "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "type": "string", "location": "query" } }, "parameterOrder": [ "name", "a2aEndpoint" ], "httpMethod": "GET", "id": "aiplatform.reasoningEngines.a2a.v1.extendedAgentCard", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "response": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/extendedAgentCard", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get request for reasoning engine instance via the A2A get protocol apis." }, "tasks": { "parameters": { "a2aEndpoint": { "pattern": "^v1/tasks$", "location": "path", "required": true, "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "type": "string" }, "historyLength": { "type": "string", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "location": "query" }, "name": { "required": true, "type": "string", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", "pattern": "^reasoningEngines/[^/]+$" } }, "id": "aiplatform.reasoningEngines.a2a.v1.tasks", "httpMethod": "GET", "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks", "response": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "parameterOrder": [ "name", "a2aEndpoint" ] }, "card": { "parameters": { "historyLength": { "location": "query", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "type": "string" }, "name": { "pattern": "^reasoningEngines/[^/]+$", "location": "path", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string", "required": true }, "a2aEndpoint": { "location": "path", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "required": true, "pattern": "^v1/card$", "type": "string" } }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/card", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "httpMethod": "GET", "response": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "id": "aiplatform.reasoningEngines.a2a.v1.card", "parameterOrder": [ "name", "a2aEndpoint" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get request for reasoning engine instance via the A2A get protocol apis." } }, "resources": { "message": { "methods": { "stream": { "parameters": { "name": { "required": true, "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "type": "string", "location": "path", "pattern": "^reasoningEngines/[^/]+$" }, "a2aEndpoint": { "location": "path", "type": "string", "required": true, "pattern": "^v1/message$", "description": "Required. The http endpoint extracted from the URL path. e.g., v1/message:stream." } }, "parameterOrder": [ "name", "a2aEndpoint" ], "httpMethod": "POST", "id": "aiplatform.reasoningEngines.a2a.v1.message.stream", "request": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:stream", "description": "Streams queries using a reasoning engine instance via the A2A streaming protocol apis.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:stream", "response": { "$ref": "GoogleApiHttpBody" } }, "send": { "id": "aiplatform.reasoningEngines.a2a.v1.message.send", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:send", "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", "request": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "parameterOrder": [ "name", "a2aEndpoint" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:send", "parameters": { "a2aEndpoint": { "type": "string", "pattern": "^v1/message$", "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", "required": true, "location": "path" }, "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "type": "string", "required": true, "pattern": "^reasoningEngines/[^/]+$", "location": "path" } }, "httpMethod": "POST", "response": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } } } } }, "tasks": { "resources": { "pushNotificationConfigs": { "methods": { "a2aGetReasoningEngine": { "id": "aiplatform.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs.a2aGetReasoningEngine", "parameterOrder": [ "name", "a2aEndpoint" ], "httpMethod": "GET", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "parameters": { "a2aEndpoint": { "required": true, "location": "path", "type": "string", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "pattern": "^v1/tasks/[^/]+/pushNotificationConfigs/[^/]+$" }, "name": { "required": true, "type": "string", "location": "path", "pattern": "^reasoningEngines/[^/]+$", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`" }, "historyLength": { "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "type": "string", "location": "query" } }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } }, "methods": { "cancel": { "id": "aiplatform.reasoningEngines.a2a.v1.tasks.cancel", "httpMethod": "POST", "parameters": { "a2aEndpoint": { "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", "pattern": "^v1/tasks/[^/]+$", "required": true, "type": "string", "location": "path" }, "name": { "location": "path", "type": "string", "required": true, "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "pattern": "^reasoningEngines/[^/]+$" } }, "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel", "parameterOrder": [ "name", "a2aEndpoint" ], "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:cancel", "response": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "request": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } } }, "pushNotificationConfigs": { "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "response": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "parameterOrder": [ "name", "a2aEndpoint" ], "parameters": { "name": { "pattern": "^reasoningEngines/[^/]+$", "location": "path", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string", "required": true }, "historyLength": { "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "type": "string", "location": "query" }, "a2aEndpoint": { "required": true, "type": "string", "location": "path", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "pattern": "^v1/tasks/[^/]+/pushNotificationConfigs$" } }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs", "id": "aiplatform.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs", "httpMethod": "GET" }, "subscribe": { "response": { "$ref": "GoogleApiHttpBody" }, "id": "aiplatform.reasoningEngines.a2a.v1.tasks.subscribe", "parameterOrder": [ "name", "a2aEndpoint" ], "description": "Stream get request for reasoning engine instance via the A2A stream get protocol apis.", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:subscribe", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe", "httpMethod": "GET", "parameters": { "a2aEndpoint": { "location": "path", "pattern": "^v1/tasks/[^/]+$", "type": "string", "required": true, "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`." }, "name": { "type": "string", "location": "path", "required": true, "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "pattern": "^reasoningEngines/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "a2aGetReasoningEngine": { "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}", "id": "aiplatform.reasoningEngines.a2a.v1.tasks.a2aGetReasoningEngine", "parameterOrder": [ "name", "a2aEndpoint" ], "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "description": "Get request for reasoning engine instance via the A2A get protocol apis.", "parameters": { "a2aEndpoint": { "pattern": "^v1/tasks/[^/]+$", "location": "path", "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "type": "string", "required": true }, "historyLength": { "type": "string", "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "location": "query" }, "name": { "pattern": "^reasoningEngines/[^/]+$", "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", "required": true, "type": "string" } }, "httpMethod": "GET", "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } } } }, "sandboxEnvironments": { "resources": { "operations": { "methods": { "wait": { "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:wait", "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.reasoningEngines.sandboxEnvironments.operations.wait", "parameters": { "name": { "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to wait on.", "required": true, "type": "string" }, "timeout": { "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration", "location": "query", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "parameterOrder": [ "name" ] }, "get": { "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", "parameters": { "name": { "required": true, "type": "string", "description": "The name of the operation resource.", "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ], "id": "aiplatform.reasoningEngines.sandboxEnvironments.operations.get" }, "list": { "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameterOrder": [ "name" ], "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations", "id": "aiplatform.reasoningEngines.sandboxEnvironments.operations.list", "path": "v1beta1/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameters": { "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "name": { "description": "The name of the operation's parent resource.", "location": "path", "required": true, "type": "string", "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$" }, "returnPartialSuccess": { "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query" }, "pageSize": { "location": "query", "type": "integer", "description": "The standard list page size.", "format": "int32" }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." } } }, "delete": { "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "type": "string", "required": true, "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", "id": "aiplatform.reasoningEngines.sandboxEnvironments.operations.delete", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ] }, "cancel": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameters": { "name": { "type": "string", "required": true, "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to be cancelled." } }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}:cancel", "id": "aiplatform.reasoningEngines.sandboxEnvironments.operations.cancel" } } } }, "methods": { "resume": { "description": "Resumes the specific SandboxEnvironment.", "id": "aiplatform.reasoningEngines.sandboxEnvironments.resume", "path": "v1beta1/{+name}:resume", "parameterOrder": [ "name" ], "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1ResumeSandboxEnvironmentRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "description": "Required. The resource name of the sandbox environment to resume. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", "type": "string", "location": "path", "required": true, "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:resume" }, "list": { "httpMethod": "GET", "description": "Lists SandboxEnvironments in a given reasoning engine.", "parameters": { "pageToken": { "description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "parent": { "description": "Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true, "location": "path", "pattern": "^reasoningEngines/[^/]+$", "type": "string" }, "filter": { "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", "type": "string", "location": "query" }, "pageSize": { "format": "int32", "type": "integer", "description": "Optional. The maximum number of SandboxEnvironments to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironments will be returned.", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+parent}/sandboxEnvironments", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentsResponse" }, "parameterOrder": [ "parent" ], "id": "aiplatform.reasoningEngines.sandboxEnvironments.list" }, "create": { "httpMethod": "POST", "request": { "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironment" }, "parameters": { "parent": { "pattern": "^reasoningEngines/[^/]+$", "description": "Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.", "type": "string", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+parent}/sandboxEnvironments", "id": "aiplatform.reasoningEngines.sandboxEnvironments.create", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Creates a SandboxEnvironment in a given reasoning engine." }, "delete": { "parameters": { "name": { "description": "Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", "type": "string", "required": true, "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "location": "path" } }, "path": "v1beta1/{+name}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Deletes the specific SandboxEnvironment.", "id": "aiplatform.reasoningEngines.sandboxEnvironments.delete", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}" }, "authorizeAccess": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "response": { "$ref": "GoogleCloudAiplatformV1beta1AuthorizeSandboxEnvironmentAccessResponse" }, "parameters": { "name": { "description": "Required. The resource name of the sandbox environment to authorize access to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", "required": true, "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "location": "path", "type": "string" } }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:authorizeAccess", "path": "v1beta1/{+name}:authorizeAccess", "request": { "$ref": "GoogleCloudAiplatformV1beta1AuthorizeSandboxEnvironmentAccessRequest" }, "description": "Checks whether the caller is authorized to access the sandbox environment. Authorization is performed entirely by the API infrastructure from the `method_policy` below; the handler is a no-op. A successful response means the caller holds `sandboxEnvironments.execute` on the named sandbox. Used by the sandbox data-plane proxy, which forwards the caller's credential and proxies traffic only on success.", "parameterOrder": [ "name" ], "id": "aiplatform.reasoningEngines.sandboxEnvironments.authorizeAccess" }, "bidiExecute": { "request": { "$ref": "GoogleCloudAiplatformV1beta1BidiExecuteSandboxEnvironmentRequest" }, "parameterOrder": [ "name" ], "httpMethod": "POST", "response": { "$ref": "GoogleCloudAiplatformV1beta1BidiExecuteSandboxEnvironmentResponse" }, "parameters": { "name": { "required": true, "type": "string", "location": "path", "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Executes using a sandbox environment with bidirectional streaming.", "id": "aiplatform.reasoningEngines.sandboxEnvironments.bidiExecute", "path": "v1beta1/{+name}:bidiExecute", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:bidiExecute" }, "snapshot": { "path": "v1beta1/{+name}:snapshot", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:snapshot", "parameters": { "name": { "type": "string", "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "required": true, "location": "path", "description": "Required. The resource name of the sandbox environment to snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`." } }, "httpMethod": "POST", "id": "aiplatform.reasoningEngines.sandboxEnvironments.snapshot", "parameterOrder": [ "name" ], "description": "Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.", "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentSnapshot" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "path": "v1beta1/{+name}", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironment" }, "httpMethod": "GET", "description": "Gets details of the specific SandboxEnvironment.", "parameters": { "name": { "required": true, "type": "string", "description": "Required. The resource name of the sandbox environment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", "location": "path", "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$" } }, "parameterOrder": [ "name" ], "id": "aiplatform.reasoningEngines.sandboxEnvironments.get" }, "execute": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1beta1/{+name}:execute", "id": "aiplatform.reasoningEngines.sandboxEnvironments.execute", "request": { "$ref": "GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentRequest" }, "response": { "$ref": "GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentResponse" }, "description": "Executes using a sandbox environment.", "parameters": { "name": { "description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", "location": "path", "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "type": "string", "required": true } }, "httpMethod": "POST", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:execute" }, "pause": { "path": "v1beta1/{+name}:pause", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:pause", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "location": "path", "description": "Required. The resource name of the sandbox environment to pause. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", "required": true, "type": "string", "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$" } }, "request": { "$ref": "GoogleCloudAiplatformV1beta1PauseSandboxEnvironmentRequest" }, "parameterOrder": [ "name" ], "description": "Pauses the specific SandboxEnvironment.", "id": "aiplatform.reasoningEngines.sandboxEnvironments.pause" } } }, "operations": { "methods": { "wait": { "path": "v1beta1/{+name}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:wait", "id": "aiplatform.reasoningEngines.operations.wait", "httpMethod": "POST", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource to wait on.", "required": true, "type": "string" }, "timeout": { "format": "google-duration", "location": "query", "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" } }, "get": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation resource.", "required": true } }, "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.reasoningEngines.operations.get", "httpMethod": "GET" }, "cancel": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:cancel", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "id": "aiplatform.reasoningEngines.operations.cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "type": "string", "required": true, "pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", "location": "path" } }, "httpMethod": "POST" }, "list": { "parameterOrder": [ "name" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameters": { "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "pageSize": { "format": "int32", "location": "query", "description": "The standard list page size.", "type": "integer" }, "name": { "type": "string", "description": "The name of the operation's parent resource.", "location": "path", "required": true, "pattern": "^reasoningEngines/[^/]+$" } }, "httpMethod": "GET", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/operations", "id": "aiplatform.reasoningEngines.operations.list" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", "parameters": { "name": { "location": "path", "description": "The name of the operation resource to be deleted.", "required": true, "pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", "type": "string" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.reasoningEngines.operations.delete", "parameterOrder": [ "name" ], "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "path": "v1beta1/{+name}" } } }, "sandboxEnvironmentTemplates": { "methods": { "create": { "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/sandboxEnvironmentTemplates", "request": { "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplate" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "parent": { "type": "string", "location": "path", "pattern": "^reasoningEngines/[^/]+$", "description": "Required. The resource name of the reasoning engine to create the SandboxEnvironmentTemplate in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.", "required": true } }, "id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.create", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates", "description": "Creates a SandboxEnvironmentTemplate in a given reasoning engine." }, "get": { "path": "v1beta1/{+name}", "httpMethod": "GET", "parameters": { "name": { "pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$", "description": "Required. The resource name of the sandbox environment template. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`", "required": true, "location": "path", "type": "string" } }, "description": "Gets details of the specific SandboxEnvironmentTemplate.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}", "response": { "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplate" }, "id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.get" }, "delete": { "id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.delete", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The resource name of the SandboxEnvironmentTemplate to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`", "location": "path", "required": true, "pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}", "httpMethod": "DELETE", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}", "description": "Deletes the specific SandboxEnvironmentTemplate." }, "list": { "response": { "$ref": "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentTemplatesResponse" }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates", "path": "v1beta1/{+parent}/sandboxEnvironmentTemplates", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists SandboxEnvironmentTemplates in a given reasoning engine.", "parameters": { "pageToken": { "type": "string", "description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironmentTemplates` call. Provide this to retrieve the subsequent page.", "location": "query" }, "parent": { "required": true, "pattern": "^reasoningEngines/[^/]+$", "description": "Required. The resource name of the reasoning engine to list sandbox environment templates from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", "type": "string" }, "filter": { "type": "string", "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", "location": "query" }, "pageSize": { "type": "integer", "description": "Optional. The maximum number of SandboxEnvironmentTemplates to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentTemplates will be returned.", "format": "int32", "location": "query" } }, "id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.list", "parameterOrder": [ "parent" ] } }, "resources": { "operations": { "methods": { "cancel": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}:cancel", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "description": "The name of the operation resource to be cancelled.", "pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", "type": "string", "location": "path" } }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1beta1/{+name}:cancel", "id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.cancel" }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.list", "path": "v1beta1/{+name}/operations", "parameters": { "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "location": "query", "description": "The standard list page size.", "type": "integer", "format": "int32" }, "name": { "location": "path", "type": "string", "required": true, "pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$", "description": "The name of the operation's parent resource." }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "returnPartialSuccess": { "location": "query", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean" } }, "httpMethod": "GET" }, "delete": { "parameters": { "name": { "pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to be deleted.", "type": "string", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.delete", "httpMethod": "DELETE", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ] }, "get": { "parameters": { "name": { "description": "The name of the operation resource.", "location": "path", "type": "string", "pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", "required": true } }, "path": "v1beta1/{+name}", "id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.get", "httpMethod": "GET", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}" }, "wait": { "parameterOrder": [ "name" ], "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}:wait", "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "timeout": { "location": "query", "format": "google-duration", "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used." }, "name": { "description": "The name of the operation resource to wait on.", "required": true, "location": "path", "type": "string", "pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.wait" } } } } }, "memories": { "methods": { "retrieveProfiles": { "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1RetrieveProfilesRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "description": "Retrieves profiles.", "parameters": { "parent": { "location": "path", "required": true, "pattern": "^reasoningEngines/[^/]+$", "description": "Required. The resource name of the ReasoningEngine to retrieve profiles from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1RetrieveProfilesResponse" }, "path": "v1beta1/{+parent}/memories:retrieveProfiles", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories:retrieveProfiles", "id": "aiplatform.reasoningEngines.memories.retrieveProfiles" }, "create": { "request": { "$ref": "GoogleCloudAiplatformV1beta1Memory" }, "id": "aiplatform.reasoningEngines.memories.create", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+parent}/memories", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Create a Memory.", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories", "parameterOrder": [ "parent" ], "parameters": { "parent": { "required": true, "location": "path", "type": "string", "pattern": "^reasoningEngines/[^/]+$", "description": "Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`" }, "memoryId": { "type": "string", "location": "query", "description": "Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number." } }, "httpMethod": "POST" }, "generate": { "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Generate memories.", "path": "v1beta1/{+parent}/memories:generate", "id": "aiplatform.reasoningEngines.memories.generate", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories:generate", "parameters": { "parent": { "required": true, "type": "string", "description": "Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", "pattern": "^reasoningEngines/[^/]+$" } }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequest" } }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}", "response": { "$ref": "GoogleCloudAiplatformV1beta1Memory" }, "path": "v1beta1/{+name}", "description": "Get a Memory.", "parameters": { "name": { "required": true, "location": "path", "pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", "type": "string", "description": "Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`" } }, "id": "aiplatform.reasoningEngines.memories.get", "httpMethod": "GET", "parameterOrder": [ "name" ] }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "description": "Delete a Memory.", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}", "path": "v1beta1/{+name}", "id": "aiplatform.reasoningEngines.memories.delete", "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "description": "Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "required": true, "pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", "type": "string" } } }, "retrieve": { "description": "Retrieve memories.", "parameterOrder": [ "parent" ], "id": "aiplatform.reasoningEngines.memories.retrieve", "httpMethod": "POST", "parameters": { "parent": { "pattern": "^reasoningEngines/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`" } }, "path": "v1beta1/{+parent}/memories:retrieve", "response": { "$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesResponse" }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories:retrieve", "request": { "$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+parent}/memories", "httpMethod": "GET", "parameters": { "pageSize": { "location": "query", "type": "integer", "description": "Optional. The standard list page size.", "format": "int32" }, "pageToken": { "description": "Optional. The standard list page token.", "type": "string", "location": "query" }, "filter": { "location": "query", "type": "string", "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `scope` (as a JSON string with equality match only) * `topics` (i.e. `topics.custom_memory_topic_label: \"example topic\" OR topics.managed_memory_topic: USER_PREFERENCES`)" }, "parent": { "required": true, "pattern": "^reasoningEngines/[^/]+$", "location": "path", "description": "Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string" }, "orderBy": { "description": "Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`", "location": "query", "type": "string" } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1ListMemoriesResponse" }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories", "description": "List Memories.", "id": "aiplatform.reasoningEngines.memories.list" }, "patch": { "httpMethod": "PATCH", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}", "parameters": { "name": { "location": "path", "type": "string", "description": "Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", "required": true }, "updateMask": { "format": "google-fieldmask", "location": "query", "type": "string", "description": "Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type`" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Update a Memory.", "id": "aiplatform.reasoningEngines.memories.patch", "path": "v1beta1/{+name}", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1Memory" } }, "rollback": { "id": "aiplatform.reasoningEngines.memories.rollback", "description": "Rollback Memory to a specific revision.", "path": "v1beta1/{+name}:rollback", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1RollbackMemoryRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", "description": "Required. The resource name of the Memory to rollback. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "type": "string", "location": "path", "required": true } }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}:rollback", "httpMethod": "POST" }, "ingestEvents": { "parameterOrder": [ "parent" ], "id": "aiplatform.reasoningEngines.memories.ingestEvents", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+parent}/memories:ingestEvents", "parameters": { "parent": { "description": "Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "pattern": "^reasoningEngines/[^/]+$", "location": "path", "type": "string", "required": true } }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories:ingestEvents", "response": { "$ref": "GoogleLongrunningOperation" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1IngestEventsRequest" }, "description": "Ingests events for a Memory Bank." }, "purge": { "id": "aiplatform.reasoningEngines.memories.purge", "description": "Purge memories.", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories:purge", "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The resource name of the ReasoningEngine to purge memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string", "location": "path", "required": true, "pattern": "^reasoningEngines/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "path": "v1beta1/{+parent}/memories:purge", "request": { "$ref": "GoogleCloudAiplatformV1beta1PurgeMemoriesRequest" } } }, "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "path": "v1beta1/{+name}:cancel", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:cancel", "httpMethod": "POST", "parameterOrder": [ "name" ], "id": "aiplatform.reasoningEngines.memories.operations.cancel", "parameters": { "name": { "location": "path", "type": "string", "required": true, "description": "The name of the operation resource to be cancelled.", "pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations", "parameters": { "pageSize": { "format": "int32", "description": "The standard list page size.", "location": "query", "type": "integer" }, "name": { "location": "path", "type": "string", "description": "The name of the operation's parent resource.", "required": true, "pattern": "^reasoningEngines/[^/]+/memories/[^/]+$" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "returnPartialSuccess": { "location": "query", "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation." }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" } }, "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "path": "v1beta1/{+name}/operations", "id": "aiplatform.reasoningEngines.memories.operations.list" }, "wait": { "httpMethod": "POST", "response": { "$ref": "GoogleLongrunningOperation" }, "path": "v1beta1/{+name}:wait", "id": "aiplatform.reasoningEngines.memories.operations.wait", "parameters": { "timeout": { "location": "query", "type": "string", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "format": "google-duration" }, "name": { "pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "required": true, "description": "The name of the operation resource to wait on." } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:wait", "parameterOrder": [ "name" ] }, "get": { "httpMethod": "GET", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}", "path": "v1beta1/{+name}", "parameters": { "name": { "required": true, "description": "The name of the operation resource.", "type": "string", "location": "path", "pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "parameterOrder": [ "name" ], "id": "aiplatform.reasoningEngines.memories.operations.get", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}", "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "location": "path", "pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource to be deleted.", "required": true } }, "id": "aiplatform.reasoningEngines.memories.operations.delete", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}", "parameterOrder": [ "name" ] } } }, "revisions": { "methods": { "get": { "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^reasoningEngines/[^/]+/memories/[^/]+/revisions/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{revision}`" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "response": { "$ref": "GoogleCloudAiplatformV1beta1MemoryRevision" }, "description": "Get a Memory Revision.", "id": "aiplatform.reasoningEngines.memories.revisions.get", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/revisions/{revisionsId}", "path": "v1beta1/{+name}" }, "list": { "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/revisions", "id": "aiplatform.reasoningEngines.memories.revisions.list", "httpMethod": "GET", "description": "List Memory Revisions for a Memory.", "parameters": { "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "Optional. The standard list page size." }, "parent": { "description": "Required. The resource name of the Memory to list revisions for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", "pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", "type": "string", "required": true }, "filter": { "location": "query", "type": "string", "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels`" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. The standard list page token." } }, "response": { "$ref": "GoogleCloudAiplatformV1beta1ListMemoryRevisionsResponse" }, "parameterOrder": [ "parent" ], "path": "v1beta1/{+parent}/revisions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } } }, "methods": { "create": { "path": "v1beta1/reasoningEngines", "parameterOrder": [], "id": "aiplatform.reasoningEngines.create", "description": "Creates a reasoning engine.", "request": { "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "description": "Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`", "location": "query", "type": "string" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "POST", "flatPath": "v1beta1/reasoningEngines" }, "query": { "httpMethod": "POST", "parameters": { "name": { "required": true, "type": "string", "pattern": "^reasoningEngines/[^/]+$", "location": "path", "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`" } }, "description": "Queries using a reasoning engine.", "id": "aiplatform.reasoningEngines.query", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}:query", "request": { "$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineRequest" }, "path": "v1beta1/{+name}:query", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineResponse" } }, "streamQuery": { "parameters": { "name": { "pattern": "^reasoningEngines/[^/]+$", "location": "path", "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "id": "aiplatform.reasoningEngines.streamQuery", "request": { "$ref": "GoogleCloudAiplatformV1beta1StreamQueryReasoningEngineRequest" }, "httpMethod": "POST", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}:streamQuery", "response": { "$ref": "GoogleApiHttpBody" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:streamQuery", "description": "Streams queries using a reasoning engine." }, "executeCode": { "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}:executeCode", "response": { "$ref": "GoogleCloudAiplatformV1beta1ExecuteCodeResponse" }, "id": "aiplatform.reasoningEngines.executeCode", "request": { "$ref": "GoogleCloudAiplatformV1beta1ExecuteCodeRequest" }, "httpMethod": "POST", "path": "v1beta1/{+name}:executeCode", "description": "Executes code statelessly.", "parameters": { "name": { "location": "path", "description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string", "required": true, "pattern": "^reasoningEngines/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "get": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", "type": "string", "required": true, "pattern": "^reasoningEngines/[^/]+$" } }, "path": "v1beta1/{+name}", "httpMethod": "GET", "parameterOrder": [ "name" ], "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}", "id": "aiplatform.reasoningEngines.get", "response": { "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" }, "description": "Gets a reasoning engine." }, "delete": { "description": "Deletes a reasoning engine.", "response": { "$ref": "GoogleLongrunningOperation" }, "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "force": { "type": "boolean", "location": "query", "description": "Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources." }, "name": { "description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "pattern": "^reasoningEngines/[^/]+$", "required": true, "type": "string", "location": "path" } }, "parameterOrder": [ "name" ], "id": "aiplatform.reasoningEngines.delete", "path": "v1beta1/{+name}" }, "patch": { "response": { "$ref": "GoogleLongrunningOperation" }, "description": "Updates a reasoning engine.", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^reasoningEngines/[^/]+$", "location": "path", "description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "type": "string", "required": true }, "updateMask": { "type": "string", "location": "query", "format": "google-fieldmask", "description": "Optional. Mask specifying which fields to update." } }, "path": "v1beta1/{+name}", "id": "aiplatform.reasoningEngines.patch", "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" } }, "cancelAsyncQuery": { "description": "Cancels an AsyncQueryReasoningEngine operation.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1CancelAsyncQueryReasoningEngineRequest" }, "parameterOrder": [ "name" ], "httpMethod": "POST", "response": { "$ref": "GoogleCloudAiplatformV1beta1CancelAsyncQueryReasoningEngineResponse" }, "id": "aiplatform.reasoningEngines.cancelAsyncQuery", "parameters": { "name": { "location": "path", "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "required": true, "pattern": "^reasoningEngines/[^/]+$", "type": "string" } }, "path": "v1beta1/{+name}:cancelAsyncQuery", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}:cancelAsyncQuery" }, "list": { "flatPath": "v1beta1/reasoningEngines", "response": { "$ref": "GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse" }, "httpMethod": "GET", "path": "v1beta1/reasoningEngines", "description": "Lists reasoning engines in a location.", "parameters": { "pageToken": { "description": "Optional. The standard list page token.", "type": "string", "location": "query" }, "parent": { "type": "string", "location": "query", "description": "Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`" }, "filter": { "location": "query", "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", "type": "string" }, "pageSize": { "format": "int32", "description": "Optional. The standard list page size.", "location": "query", "type": "integer" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.reasoningEngines.list", "parameterOrder": [] }, "asyncQuery": { "id": "aiplatform.reasoningEngines.asyncQuery", "request": { "$ref": "GoogleCloudAiplatformV1beta1AsyncQueryReasoningEngineRequest" }, "description": "Async query using a reasoning engine.", "httpMethod": "POST", "path": "v1beta1/{+name}:asyncQuery", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}:asyncQuery", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "location": "path", "pattern": "^reasoningEngines/[^/]+$", "required": true, "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" } } } }, "media": { "methods": { "upload": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "supportsMediaUpload": true, "mediaUpload": { "accept": [ "*/*" ], "protocols": { "simple": { "path": "/upload/v1beta1/{+parent}/ragFiles:upload", "multipart": true } } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:upload", "response": { "$ref": "GoogleCloudAiplatformV1beta1UploadRagFileResponse" }, "path": "v1beta1/{+parent}/ragFiles:upload", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", "required": true, "description": "Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", "location": "path" } }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudAiplatformV1beta1UploadRagFileRequest" }, "description": "Upload a file into a RagCorpus.", "id": "aiplatform.media.upload" } } }, "operations": { "methods": { "get": { "parameterOrder": [ "name" ], "id": "aiplatform.operations.get", "path": "v1beta1/{+name}", "flatPath": "v1beta1/operations/{operationsId}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameters": { "name": { "required": true, "location": "path", "type": "string", "pattern": "^operations/[^/]+$", "description": "The name of the operation resource." } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "httpMethod": "GET" }, "cancel": { "flatPath": "v1beta1/operations/{operationsId}:cancel", "path": "v1beta1/{+name}:cancel", "id": "aiplatform.operations.cancel", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "name": { "location": "path", "type": "string", "description": "The name of the operation resource to be cancelled.", "required": true, "pattern": "^operations/[^/]+$" } }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ] }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "flatPath": "v1beta1/operations/{operationsId}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.operations.wait", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1beta1/{+name}:wait", "parameters": { "timeout": { "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "type": "string" }, "name": { "description": "The name of the operation resource to wait on.", "location": "path", "type": "string", "required": true, "pattern": "^operations/[^/]+$" } }, "httpMethod": "POST" }, "list": { "id": "aiplatform.operations.list", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v1beta1/operations", "httpMethod": "GET", "flatPath": "v1beta1/operations", "parameters": { "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "name": { "description": "The name of the operation's parent resource.", "location": "query", "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "description": "The standard list page size.", "location": "query" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } }, "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameterOrder": [] }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "id": "aiplatform.operations.delete", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^operations/[^/]+$", "required": true, "location": "path", "type": "string", "description": "The name of the operation resource to be deleted." } }, "path": "v1beta1/{+name}", "flatPath": "v1beta1/operations/{operationsId}" } } }, "notebookRuntimes": { "resources": { "operations": { "methods": { "get": { "httpMethod": "GET", "parameterOrder": [ "name" ], "flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", "parameters": { "name": { "required": true, "description": "The name of the operation resource.", "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", "location": "path", "type": "string" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "id": "aiplatform.notebookRuntimes.operations.get", "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "path": "v1beta1/{+name}" }, "cancel": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", "type": "string", "required": true, "location": "path", "description": "The name of the operation resource to be cancelled." } }, "httpMethod": "POST", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "id": "aiplatform.notebookRuntimes.operations.cancel", "path": "v1beta1/{+name}:cancel", "flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel" }, "delete": { "httpMethod": "DELETE", "flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", "parameters": { "name": { "required": true, "description": "The name of the operation resource to be deleted.", "location": "path", "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", "type": "string" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "path": "v1beta1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.notebookRuntimes.operations.delete", "parameterOrder": [ "name" ] }, "wait": { "httpMethod": "POST", "parameters": { "name": { "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to wait on.", "location": "path", "type": "string", "required": true }, "timeout": { "format": "google-duration", "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", "location": "query", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "id": "aiplatform.notebookRuntimes.operations.wait", "path": "v1beta1/{+name}:wait", "parameterOrder": [ "name" ], "flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait", "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", "response": { "$ref": "GoogleLongrunningOperation" } }, "list": { "scopes": [ "https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "aiplatform.notebookRuntimes.operations.list", "httpMethod": "GET", "parameters": { "name": { "required": true, "location": "path", "description": "The name of the operation's parent resource.", "type": "string", "pattern": "^notebookRuntimes/[^/]+$" }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "The standard list page size." }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "pageToken": { "description": "The standard list page token.", "type": "string", "location": "query" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } }, "flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations", "path": "v1beta1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "parameterOrder": [ "name" ] } } } } } }, "schemas": { "GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingSpec": { "properties": {}, "description": "Spec for RubricBasedInstructionFollowing metric - returns rubrics and verdicts corresponding to rubrics along with overall score.", "id": "GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingSpec", "type": "object" }, "GenaiVertexV1beta1FileSearch": { "description": "A tool that can be used by the model to search files.", "properties": { "topK": { "type": "integer", "format": "int32", "description": "The number of semantic retrieval chunks to retrieve." }, "metadataFilter": { "type": "string", "description": "Metadata filter to apply to the semantic retrieval documents and chunks." }, "fileSearchStoreNames": { "type": "array", "items": { "type": "string" }, "description": "The file search store names to search." } }, "id": "GenaiVertexV1beta1FileSearch", "type": "object" }, "GoogleCloudAiplatformV1beta1ContainerRegistryDestination": { "type": "object", "properties": { "outputUri": { "type": "string", "description": "Required. Container Registry URI of a container image. Only Google Container Registry and Artifact Registry are supported now. Accepted forms: * Google Container Registry path. For example: `gcr.io/projectId/imageName:tag`. * Artifact Registry path. For example: `us-central1-docker.pkg.dev/projectId/repoName/imageName:tag`. If a tag is not specified, \"latest\" will be used as the default tag." } }, "id": "GoogleCloudAiplatformV1beta1ContainerRegistryDestination", "description": "The Container Registry location for the container image." }, "GoogleCloudAiplatformV1beta1GoogleMapsRouting": { "properties": {}, "id": "GoogleCloudAiplatformV1beta1GoogleMapsRouting", "description": "Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute).", "type": "object" }, "GoogleCloudAiplatformV1beta1ListContextsResponse": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ListContextsResponse", "description": "Response message for MetadataService.ListContexts.", "properties": { "nextPageToken": { "type": "string", "description": "A token, which can be sent as ListContextsRequest.page_token to retrieve the next page. If this field is not populated, there are no subsequent pages." }, "contexts": { "description": "The Contexts retrieved from the MetadataStore.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Context" } } } }, "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpec": { "properties": { "imageSpec": { "description": "Optional. Configuration for building an image with custom config file.", "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecImageSpec" }, "developerConnectSource": { "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecDeveloperConnectSource", "description": "Source code is in a Git repository managed by Developer Connect." }, "inlineSource": { "description": "Source code is provided directly in the request.", "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecInlineSource" }, "agentConfigSource": { "description": "Source code is generated from the agent config.", "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecAgentConfigSource" }, "pythonSpec": { "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecPythonSpec", "description": "Configuration for a Python application." } }, "description": "Specification for deploying from source code.", "type": "object", "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpec" }, "GoogleCloudAiplatformV1beta1PrivateServiceConnectConfig": { "type": "object", "properties": { "projectAllowlist": { "type": "array", "items": { "type": "string" }, "description": "A list of Projects from which the forwarding rule will target the service attachment." }, "serviceAttachment": { "description": "Output only. The name of the generated service attachment resource. This is only populated if the endpoint is deployed with PrivateServiceConnect.", "readOnly": true, "type": "string" }, "enablePrivateServiceConnect": { "type": "boolean", "description": "Required. If true, expose the IndexEndpoint via private service connect." }, "enableSecurePrivateServiceConnect": { "type": "boolean", "description": "Optional. If set to true, enable secure private service connect with IAM authorization. Otherwise, private service connect will be done without authorization. Note latency will be slightly increased if authorization is enabled." }, "pscAutomationConfigs": { "items": { "$ref": "GoogleCloudAiplatformV1beta1PSCAutomationConfig" }, "type": "array", "description": "Optional. List of projects and networks where the PSC endpoints will be created. This field is used by Online Inference(Prediction) only." } }, "description": "Represents configuration for private service connect.", "id": "GoogleCloudAiplatformV1beta1PrivateServiceConnectConfig" }, "GoogleCloudAiplatformV1beta1SchemaPredictInstanceTextSentimentPredictionInstance": { "properties": { "content": { "description": "The text snippet to make the predictions on.", "type": "string" }, "mimeType": { "type": "string", "description": "The MIME type of the text snippet. The supported MIME types are listed below. - text/plain" } }, "type": "object", "description": "Prediction input format for Text Sentiment.", "id": "GoogleCloudAiplatformV1beta1SchemaPredictInstanceTextSentimentPredictionInstance" }, "GenaiVertexV1beta1TextContent": { "description": "A text content block. ", "id": "GenaiVertexV1beta1TextContent", "properties": { "text": { "description": "Required. The text content.", "type": "string" }, "annotations": { "description": "Citation information for model-generated content.", "items": { "$ref": "GenaiVertexV1beta1TextContentAnnotation" }, "type": "array" } }, "type": "object" }, "GenaiVertexV1beta1CreateInteractionRequest": { "type": "object", "properties": { "stream": { "description": "Input only. Whether the interaction will be streamed.", "type": "boolean" }, "store": { "description": "Input only. Whether to store the response and request for later retrieval.", "type": "boolean" }, "interaction": { "description": "The interaction to create.", "$ref": "GenaiVertexV1beta1Interaction" }, "background": { "description": "Input only. Whether to run the model interaction in the background.", "type": "boolean" } }, "description": "Configuration parameters for creating an interaction.", "id": "GenaiVertexV1beta1CreateInteractionRequest" }, "GoogleCloudAiplatformV1beta1EventMetadata": { "description": "Metadata relating to a LLM response event.", "properties": { "groundingMetadata": { "description": "Optional. Metadata returned to client when grounding is enabled.", "$ref": "GoogleCloudAiplatformV1beta1GroundingMetadata" }, "longRunningToolIds": { "items": { "type": "string" }, "type": "array", "description": "Optional. Set of ids of the long running function calls. Agent client will know from this field about which function call is long running. Only valid for function call event." }, "inputTranscription": { "$ref": "GoogleCloudAiplatformV1beta1Transcription", "description": "Optional. Audio transcription of user input." }, "customMetadata": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "The custom metadata of the LlmResponse.", "type": "object" }, "turnComplete": { "type": "boolean", "description": "Optional. Indicates whether the response from the model is complete. Only used for streaming mode." }, "interrupted": { "type": "boolean", "description": "Optional. Flag indicating that LLM was interrupted when generating the content. Usually it's due to user interruption during a bidi streaming." }, "branch": { "description": "Optional. The branch of the event. The format is like agent_1.agent_2.agent_3, where agent_1 is the parent of agent_2, and agent_2 is the parent of agent_3. Branch is used when multiple child agents shouldn't see their siblings' conversation history.", "type": "string" }, "partial": { "type": "boolean", "description": "Optional. Indicates whether the text content is part of a unfinished text stream. Only used for streaming mode and when the content is plain text." }, "outputTranscription": { "description": "Optional. Audio transcription of model output.", "$ref": "GoogleCloudAiplatformV1beta1Transcription" } }, "id": "GoogleCloudAiplatformV1beta1EventMetadata", "type": "object" }, "GoogleCloudAiplatformV1beta1GenerateFetchAccessTokenResponse": { "id": "GoogleCloudAiplatformV1beta1GenerateFetchAccessTokenResponse", "type": "object", "properties": { "accessToken": { "description": "The OAuth 2.0 access token.", "type": "string" }, "expireTime": { "type": "string", "description": "Token expiration time. This is always set", "format": "google-datetime" } }, "description": "Response message for FeatureOnlineStoreService.GenerateFetchAccessToken." }, "GoogleCloudAiplatformV1beta1CreateDeploymentResourcePoolOperationMetadata": { "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "The operation generic information." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1CreateDeploymentResourcePoolOperationMetadata", "description": "Runtime operation information for CreateDeploymentResourcePool method." }, "GenaiVertexV1beta1VideoDelta": { "properties": { "mimeType": { "enum": [ "TYPE_UNSPECIFIED", "TYPE_MP4", "TYPE_MPEG", "TYPE_MPG", "TYPE_MOV", "TYPE_AVI", "TYPE_X_FLV", "TYPE_WEBM", "TYPE_WMV", "TYPE_3GPP", "TYPE_JPEG2000" ], "enumDescriptions": [ "", "MP4 video format", "MPEG video format", "MPG video format", "MOV video format", "AVI video format", "FLV video format", "WebM video format", "WMV video format", "3GPP video format", "JPEG 2000 video format" ], "type": "string" }, "data": { "format": "byte", "type": "string" }, "uri": { "type": "string" }, "resolution": { "description": "The resolution of the media.", "enum": [ "MEDIA_RESOLUTION_UNSPECIFIED", "LOW", "MEDIUM", "HIGH", "ULTRA_HIGH" ], "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "Low resolution.", "Medium resolution.", "High resolution.", "Ultra high resolution." ] } }, "id": "GenaiVertexV1beta1VideoDelta", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation": { "description": "Training pipeline will infer the proper transformation based on the statistic of dataset.", "type": "object", "properties": { "columnName": { "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation" }, "GoogleCloudAiplatformV1beta1ConversationTurn": { "type": "object", "description": "Represents a single turn/invocation in the conversation.", "id": "GoogleCloudAiplatformV1beta1ConversationTurn", "properties": { "events": { "description": "Optional. The list of events that occurred during this turn.", "items": { "$ref": "GoogleCloudAiplatformV1beta1AgentEvent" }, "type": "array" }, "turnId": { "description": "Optional. A unique identifier for the turn. Useful for referencing specific turns across systems.", "type": "string" }, "turnIndex": { "type": "integer", "description": "Required. The 0-based index of the turn in the conversation sequence.", "format": "int32" } } }, "GoogleCloudAiplatformV1beta1ToolNameMatchMetricValue": { "properties": { "score": { "readOnly": true, "format": "float", "description": "Output only. Tool name match score.", "type": "number" } }, "type": "object", "description": "Tool name match metric value for an instance.", "id": "GoogleCloudAiplatformV1beta1ToolNameMatchMetricValue" }, "GoogleCloudAiplatformV1beta1TensorboardExperiment": { "id": "GoogleCloudAiplatformV1beta1TensorboardExperiment", "properties": { "source": { "type": "string", "description": "Immutable. Source of the TensorboardExperiment. Example: a custom training job." }, "displayName": { "type": "string", "description": "User provided name of this TensorboardExperiment." }, "etag": { "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "type": "string" }, "description": { "type": "string", "description": "Description of this TensorboardExperiment." }, "updateTime": { "description": "Output only. Timestamp when this TensorboardExperiment was last updated.", "format": "google-datetime", "type": "string", "readOnly": true }, "name": { "description": "Output only. Name of the TensorboardExperiment. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", "readOnly": true, "type": "string" }, "createTime": { "type": "string", "readOnly": true, "description": "Output only. Timestamp when this TensorboardExperiment was created.", "format": "google-datetime" }, "labels": { "description": "The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `aiplatform.googleapis.com/` and are immutable. The following system labels exist for each Dataset: * `aiplatform.googleapis.com/dataset_metadata_schema`: output only. Its value is the metadata_schema's title.", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "description": "A TensorboardExperiment is a group of TensorboardRuns, that are typically the results of a training job run, in a Tensorboard." }, "GoogleCloudAiplatformV1beta1CancelDataLabelingJobRequest": { "description": "Request message for JobService.CancelDataLabelingJob.", "properties": {}, "type": "object", "id": "GoogleCloudAiplatformV1beta1CancelDataLabelingJobRequest" }, "GoogleCloudAiplatformV1beta1ListOnlineEvaluatorsResponse": { "description": "Response message for ListOnlineEvaluators.", "properties": { "nextPageToken": { "type": "string", "description": "A token to retrieve the next page. Absence of this field indicates there are no subsequent pages." }, "onlineEvaluators": { "items": { "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluator" }, "type": "array", "description": "A list of OnlineEvaluators matching the request." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ListOnlineEvaluatorsResponse" }, "GoogleCloudAiplatformV1beta1ToolUseExampleExtensionOperation": { "type": "object", "description": "Identifies one operation of the extension.", "properties": { "extension": { "type": "string", "description": "Resource name of the extension." }, "operationId": { "type": "string", "description": "Required. Operation ID of the extension." } }, "id": "GoogleCloudAiplatformV1beta1ToolUseExampleExtensionOperation" }, "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeature": { "type": "object", "id": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeature", "properties": { "value": { "description": "Feature value. A user provided timestamp may be set in the `FeatureValue.metadata.generate_time` field.", "$ref": "GoogleCloudAiplatformV1beta1FeatureValue" }, "name": { "description": "Feature short name.", "type": "string" }, "valueAndTimestamp": { "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeatureFeatureValueAndTimestamp", "description": "Feature value and timestamp." } }, "description": "Feature name & value pair." }, "GoogleCloudAiplatformV1beta1ExecuteExtensionRequest": { "properties": { "runtimeAuthConfig": { "description": "Optional. Auth config provided at runtime to override the default value in Extension.manifest.auth_config. The AuthConfig.auth_type should match the value in Extension.manifest.auth_config.", "$ref": "GoogleCloudAiplatformV1beta1AuthConfig" }, "operationParams": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "Optional. Request parameters that will be used for executing this operation. The struct should be in a form of map with param name as the key and actual param value as the value. E.g. If this operation requires a param \"name\" to be set to \"abc\". you can set this to something like {\"name\": \"abc\"}." }, "operationId": { "description": "Required. The desired ID of the operation to be executed in this extension as defined in ExtensionOperation.operation_id.", "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ExecuteExtensionRequest", "description": "Request message for ExtensionExecutionService.ExecuteExtension." }, "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveSpecTabularObjective": { "id": "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveSpecTabularObjective", "description": "Tabular monitoring objective.", "properties": { "featureDriftSpec": { "description": "Input feature distribution drift monitoring spec.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveSpecDataDriftSpec" }, "featureAttributionSpec": { "description": "Feature attribution monitoring spec.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveSpecFeatureAttributionSpec" }, "predictionOutputDriftSpec": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveSpecDataDriftSpec", "description": "Prediction output distribution drift monitoring spec." } }, "type": "object" }, "GenaiVertexV1beta1EnvironmentConfigEgressRule": { "id": "GenaiVertexV1beta1EnvironmentConfigEgressRule", "type": "object", "properties": { "transform": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Headers to inject into requests matching this rule. Key: header name (e.g., \"Authorization\"). Value: header value (e.g., \"Bearer your-token\")." }, "domain": { "description": "The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains.", "type": "string" } }, "description": "A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request." }, "GoogleCloudAiplatformV1beta1DynamicRetrievalConfig": { "id": "GoogleCloudAiplatformV1beta1DynamicRetrievalConfig", "properties": { "dynamicThreshold": { "type": "number", "format": "float", "description": "Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used." }, "mode": { "description": "The mode of the predictor to be used in dynamic retrieval.", "enum": [ "MODE_UNSPECIFIED", "MODE_DYNAMIC" ], "enumDescriptions": [ "Always trigger retrieval.", "Run retrieval only when system decides it is necessary." ], "type": "string" } }, "type": "object", "description": "Describes the options to customize dynamic retrieval." }, "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigInferenceAgentConfig": { "description": "Configuration that describes an agent.", "properties": { "tools": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Tool" }, "type": "array", "description": "Optional. The tools available to the agent." }, "developerInstruction": { "description": "Optional. The developer instruction for the agent.", "$ref": "GoogleCloudAiplatformV1beta1Content" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigInferenceAgentConfig" }, "GoogleCloudAiplatformV1beta1PairwiseMetricInput": { "id": "GoogleCloudAiplatformV1beta1PairwiseMetricInput", "type": "object", "description": "Input for pairwise metric.", "properties": { "instance": { "description": "Required. Pairwise metric instance.", "$ref": "GoogleCloudAiplatformV1beta1PairwiseMetricInstance" }, "metricSpec": { "description": "Required. Spec for pairwise metric.", "$ref": "GoogleCloudAiplatformV1beta1PairwiseMetricSpec" } } }, "GoogleCloudAiplatformV1beta1QueryReasoningEngineResponse": { "properties": { "output": { "type": "any", "description": "Response provided by users in JSON object format." } }, "id": "GoogleCloudAiplatformV1beta1QueryReasoningEngineResponse", "description": "Response message for ReasoningEngineExecutionService.QueryReasoningEngine.", "type": "object" }, "GoogleCloudAiplatformV1beta1Content": { "description": "The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.", "id": "GoogleCloudAiplatformV1beta1Content", "type": "object", "properties": { "parts": { "description": "Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Part" }, "type": "array" }, "role": { "type": "string", "description": "Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'." } } }, "GoogleCloudAiplatformV1beta1Annotation": { "properties": { "payload": { "type": "any", "description": "Required. The schema of the payload can be found in payload_schema." }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Timestamp when this Annotation was created.", "type": "string" }, "name": { "description": "Output only. Resource name of the Annotation.", "readOnly": true, "type": "string" }, "annotationSource": { "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1UserActionReference", "description": "Output only. The source of the Annotation." }, "labels": { "description": "Optional. The labels with user-defined metadata to organize your Annotations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Annotation(System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable. Following system labels exist for each Annotation: * \"aiplatform.googleapis.com/annotation_set_name\": optional, name of the UI's annotation set this Annotation belongs to. If not set, the Annotation is not visible in the UI. * \"aiplatform.googleapis.com/payload_schema\": output only, its value is the payload_schema's title.", "additionalProperties": { "type": "string" }, "type": "object" }, "updateTime": { "description": "Output only. Timestamp when this Annotation was last updated.", "format": "google-datetime", "type": "string", "readOnly": true }, "payloadSchemaUri": { "description": "Required. Google Cloud Storage URI points to a YAML file describing payload. 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). The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the chosen schema must be consistent with the parent Dataset's metadata.", "type": "string" }, "etag": { "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1Annotation", "description": "Used to assign specific AnnotationSpec to a particular area of a DataItem or the whole part of the DataItem.", "type": "object" }, "GoogleCloudAiplatformV1beta1BatchPredictionJobInstanceConfig": { "description": "Configuration defining how to transform batch prediction input instances to the instances that the Model accepts.", "id": "GoogleCloudAiplatformV1beta1BatchPredictionJobInstanceConfig", "type": "object", "properties": { "excludedFields": { "items": { "type": "string" }, "description": "Fields that will be excluded in the prediction instance that is sent to the Model. Excluded will be attached to the batch prediction output if key_field is not specified. When excluded_fields is populated, included_fields must be empty. The input must be JSONL with objects at each line, BigQuery or TfRecord.", "type": "array" }, "keyField": { "type": "string", "description": "The name of the field that is considered as a key. The values identified by the key field is not included in the transformed instances that is sent to the Model. This is similar to specifying this name of the field in excluded_fields. In addition, the batch prediction output will not include the instances. Instead the output will only include the value of the key field, in a field named `key` in the output: * For `jsonl` output format, the output will have a `key` field instead of the `instance` field. * For `csv`/`bigquery` output format, the output will have have a `key` column instead of the instance feature columns. The input must be JSONL with objects at each line, CSV, BigQuery or TfRecord." }, "includedFields": { "items": { "type": "string" }, "type": "array", "description": "Fields that will be included in the prediction instance that is sent to the Model. If instance_type is `array`, the order of field names in included_fields also determines the order of the values in the array. When included_fields is populated, excluded_fields must be empty. The input must be JSONL with objects at each line, BigQuery or TfRecord." }, "instanceType": { "type": "string", "description": "The format of the instance that the Model accepts. Vertex AI will convert compatible batch prediction input instance formats to the specified format. Supported values are: * `object`: Each input is converted to JSON object format. * For `bigquery`, each row is converted to an object. * For `jsonl`, each line of the JSONL input must be an object. * Does not apply to `csv`, `file-list`, `tf-record`, or `tf-record-gzip`. * `array`: Each input is converted to JSON array format. * For `bigquery`, each row is converted to an array. The order of columns is determined by the BigQuery column order, unless included_fields is populated. included_fields must be populated for specifying field orders. * For `jsonl`, if each line of the JSONL input is an object, included_fields must be populated for specifying field orders. * Does not apply to `csv`, `file-list`, `tf-record`, or `tf-record-gzip`. If not specified, Vertex AI converts the batch prediction input as follows: * For `bigquery` and `csv`, the behavior is the same as `array`. The order of columns is the same as defined in the file or table, unless included_fields is populated. * For `jsonl`, the prediction instance format is determined by each line of the input. * For `tf-record`/`tf-record-gzip`, each record will be converted to an object in the format of `{\"b64\": }`, where `` is the Base64-encoded string of the content of the record. * For `file-list`, each file in the list will be converted to an object in the format of `{\"b64\": }`, where `` is the Base64-encoded string of the content of the file." } } }, "GoogleCloudAiplatformV1beta1GenerateMemoriesRequestDirectMemoriesSourceDirectMemory": { "type": "object", "id": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequestDirectMemoriesSourceDirectMemory", "description": "A direct memory to upload to Memory Bank.", "properties": { "topics": { "description": "Optional. The topics that the consolidated memories should be associated with.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1MemoryTopicId" } }, "fact": { "description": "Required. The fact to consolidate with existing memories.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1ListModelVersionCheckpointsResponse": { "properties": { "checkpoints": { "description": "List of Model Version checkpoints.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModelVersionCheckpoint" } }, "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results. Pass to ListModelVersionCheckpointsRequest.page_token to obtain that page." } }, "description": "Response message for ModelService.ListModelVersionCheckpoints", "id": "GoogleCloudAiplatformV1beta1ListModelVersionCheckpointsResponse", "type": "object" }, "GoogleCloudAiplatformV1beta1NasJobSpecMultiTrialAlgorithmSpecMetricSpec": { "type": "object", "description": "Represents a metric to optimize.", "properties": { "metricId": { "description": "Required. The ID of the metric. Must not contain whitespaces.", "type": "string" }, "goal": { "enum": [ "GOAL_TYPE_UNSPECIFIED", "MAXIMIZE", "MINIMIZE" ], "type": "string", "description": "Required. The optimization goal of the metric.", "enumDescriptions": [ "Goal Type will default to maximize.", "Maximize the goal metric.", "Minimize the goal metric." ] } }, "id": "GoogleCloudAiplatformV1beta1NasJobSpecMultiTrialAlgorithmSpecMetricSpec" }, "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsConfusionMatrix": { "properties": { "annotationSpecs": { "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef" }, "type": "array", "description": "AnnotationSpecs used in the confusion matrix. For AutoML Text Extraction, a special negative AnnotationSpec with empty `id` and `displayName` of \"NULL\" will be added as the last element." }, "rows": { "description": "Rows in the confusion matrix. The number of rows is equal to the size of `annotationSpecs`. `rowsi` is the number of DataItems that have ground truth of the `annotationSpecs[i]` and are predicted as `annotationSpecs[j]` by the Model being evaluated. For Text Extraction, when `annotationSpecs[i]` is the last element in `annotationSpecs`, i.e. the special negative AnnotationSpec, `rowsi` is the number of predicted entities of `annoatationSpec[j]` that are not labeled as any of the ground truth AnnotationSpec. When annotationSpecs[j] is the special negative AnnotationSpec, `rowsi` is the number of entities have ground truth of `annotationSpec[i]` that are not predicted as an entity by the Model. The value of the last cell, i.e. `rowi` where i == j and `annotationSpec[i]` is the special negative AnnotationSpec, is always 0.", "type": "array", "items": { "items": { "type": "any" }, "type": "array" } } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsConfusionMatrix" }, "GenaiVertexV1beta1FileSearchCallContent": { "description": "File Search content.", "id": "GenaiVertexV1beta1FileSearchCallContent", "properties": {}, "type": "object", "deprecated": true }, "GoogleCloudAiplatformV1beta1FulfillmentResult": { "type": "object", "properties": { "score": { "type": "number", "format": "float", "description": "Output only. Fulfillment score.", "readOnly": true }, "explanation": { "type": "string", "description": "Output only. Explanation for fulfillment score.", "readOnly": true }, "confidence": { "format": "float", "description": "Output only. Confidence for fulfillment score.", "readOnly": true, "type": "number" } }, "id": "GoogleCloudAiplatformV1beta1FulfillmentResult", "description": "Spec for fulfillment result." }, "GoogleCloudAiplatformV1beta1A2aTask": { "properties": { "generation": { "readOnly": true, "format": "int64", "description": "Output only. The task generation number.", "type": "string" }, "name": { "description": "Identifier. The resource name of the task. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` or `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTasks/{a2a_task}`", "type": "string" }, "history": { "readOnly": true, "description": "Output only. The history of the task messages.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1A2aTaskMessage" } }, "updateTime": { "description": "Output only. The last update timestamp of the task.", "type": "string", "format": "google-datetime", "readOnly": true }, "metadata": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object", "description": "Optional. Arbitrary, user-defined metadata." }, "state": { "enumDescriptions": [ "Task state unspecified. Default value if not set.", "Task is submitted and waiting to be processed.", "Task is actively being processed.", "Task is finished.", "Task is cancelled.", "Task has failed.", "Task is rejected by the system.", "Task requires input from the user.", "Task requires auth (e.g. OAuth) from the user.", "Task is paused." ], "type": "string", "readOnly": true, "description": "Output only. The state of the task. The state of a new task is SUBMITTED by default. The state of a task can only be updated via AppendA2aTaskEvents API.", "enum": [ "STATE_UNSPECIFIED", "SUBMITTED", "WORKING", "COMPLETED", "CANCELLED", "FAILED", "REJECTED", "INPUT_REQUIRED", "AUTH_REQUIRED", "PAUSED" ] }, "appId": { "description": "Optional. Agent application which created the task.", "type": "string" }, "output": { "description": "Optional. The final output of the task.", "$ref": "GoogleCloudAiplatformV1beta1TaskOutput" }, "expireTime": { "description": "Optional. Timestamp of when this task is considered expired. This is *always* provided on output, and is calculated based on the `ttl` if set on the request", "type": "string", "format": "google-datetime" }, "contextId": { "type": "string", "description": "Optional. A generic identifier for grouping related tasks (e.g., session_id, workflow_id)." }, "userId": { "type": "string", "description": "Optional. Task owner user ID." }, "artifacts": { "description": "Output only. The artifacts produced by the task.", "type": "array", "readOnly": true, "items": { "$ref": "GoogleCloudAiplatformV1beta1A2aTaskArtifact" } }, "nextEventSequenceNumber": { "description": "Output only. The next event sequence number to be appended to the task. This value starts at 1 and is guaranteed to be monotonically increasing.", "readOnly": true, "type": "string", "format": "int64" }, "status": { "$ref": "GoogleCloudAiplatformV1beta1A2aTaskStatus", "readOnly": true, "description": "Output only. The status of the task, including the state, status message, and timestamp." }, "statusDetails": { "$ref": "GoogleCloudAiplatformV1beta1TaskStatusDetails", "description": "Optional. The status details of the task." }, "createTime": { "description": "Output only. The creation timestamp of the task.", "readOnly": true, "format": "google-datetime", "type": "string" }, "ttl": { "format": "google-duration", "type": "string", "description": "Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 24 hours by default. Valid range: (0 seconds, 1000 days]" } }, "id": "GoogleCloudAiplatformV1beta1A2aTask", "description": "An A2aTask represents a unit of work.", "type": "object" }, "GoogleCloudAiplatformV1beta1TrajectoryExactMatchMetricValue": { "description": "TrajectoryExactMatch metric value for an instance.", "type": "object", "id": "GoogleCloudAiplatformV1beta1TrajectoryExactMatchMetricValue", "properties": { "score": { "format": "float", "readOnly": true, "type": "number", "description": "Output only. TrajectoryExactMatch score." } } }, "GoogleCloudAiplatformV1beta1FeatureStatsAndAnomaly": { "id": "GoogleCloudAiplatformV1beta1FeatureStatsAndAnomaly", "description": "Stats and Anomaly generated by FeatureMonitorJobs. Anomaly only includes Drift.", "properties": { "featureMonitorJobId": { "description": "The ID of the FeatureMonitorJob that generated this FeatureStatsAndAnomaly.", "type": "string", "format": "int64" }, "featureId": { "type": "string", "description": "Feature Id." }, "featureMonitorId": { "description": "The ID of the FeatureMonitor that this FeatureStatsAndAnomaly generated according to.", "type": "string" }, "statsTime": { "description": "The timestamp we take snapshot for feature values to generate stats.", "format": "google-datetime", "type": "string" }, "distributionDeviation": { "type": "number", "format": "double", "description": "Deviation from the current stats to baseline stats. 1. For categorical feature, the distribution distance is calculated by L-inifinity norm. 2. For numerical feature, the distribution distance is calculated by Jensen–Shannon divergence." }, "driftDetectionThreshold": { "type": "number", "format": "double", "description": "This is the threshold used when detecting drifts, which is set in FeatureMonitor.FeatureSelectionConfig.FeatureConfig.drift_threshold" }, "featureStats": { "description": "Feature stats. e.g. histogram buckets. In the format of tensorflow.metadata.v0.DatasetFeatureStatistics.", "type": "any" }, "driftDetected": { "type": "boolean", "description": "If set to true, indicates current stats is detected as and comparing with baseline stats." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1PauseModelDeploymentMonitoringJobRequest": { "properties": {}, "type": "object", "id": "GoogleCloudAiplatformV1beta1PauseModelDeploymentMonitoringJobRequest", "description": "Request message for JobService.PauseModelDeploymentMonitoringJob." }, "GoogleCloudAiplatformV1beta1ModelEvaluation": { "type": "object", "description": "A collection of metrics calculated by comparing Model's predictions on all of the test data against annotations from the test data.", "properties": { "biasConfigs": { "description": "Specify the configuration for bias detection.", "$ref": "GoogleCloudAiplatformV1beta1ModelEvaluationBiasConfig" }, "createTime": { "description": "Output only. Timestamp when this ModelEvaluation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "metrics": { "description": "Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri", "type": "any" }, "sliceDimensions": { "description": "All possible dimensions of ModelEvaluationSlices. The dimensions can be used as the filter of the ModelService.ListModelEvaluationSlices request, in the form of `slice.dimension = `.", "type": "array", "items": { "type": "string" } }, "name": { "type": "string", "description": "Output only. The resource name of the ModelEvaluation.", "readOnly": true }, "displayName": { "description": "The display name of the ModelEvaluation.", "type": "string" }, "metadata": { "description": "The metadata of the ModelEvaluation. For the ModelEvaluation uploaded from Managed Pipeline, metadata contains a structured value with keys of \"pipeline_job_id\", \"evaluation_dataset_type\", \"evaluation_dataset_path\", \"row_based_metrics_path\".", "type": "any" }, "explanationSpecs": { "items": { "$ref": "GoogleCloudAiplatformV1beta1ModelEvaluationModelEvaluationExplanationSpec" }, "type": "array", "description": "Describes the values of ExplanationSpec that are used for explaining the predicted values on the evaluated data." }, "metricsSchemaUri": { "type": "string", "description": "Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluation. 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)." }, "modelExplanation": { "$ref": "GoogleCloudAiplatformV1beta1ModelExplanation", "description": "Aggregated explanation metrics for the Model's prediction output over the data this ModelEvaluation uses. This field is populated only if the Model is evaluated with explanations, and only for AutoML tabular Models. " } }, "id": "GoogleCloudAiplatformV1beta1ModelEvaluation" }, "GoogleCloudAiplatformV1beta1TrainingConfig": { "type": "object", "properties": { "timeoutTrainingMilliHours": { "description": "The timeout hours for the CMLE training job, expressed in milli hours i.e. 1,000 value in this field means 1 hour.", "format": "int64", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1TrainingConfig", "description": "CMLE training config. For every active learning labeling iteration, system will train a machine learning model on CMLE. The trained model will be used by data sampling algorithm to select DataItems." }, "GoogleCloudAiplatformV1beta1FullFineTuningSpec": { "type": "object", "id": "GoogleCloudAiplatformV1beta1FullFineTuningSpec", "properties": { "trainingDatasetUri": { "description": "Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.", "type": "string" }, "validationDatasetUri": { "description": "Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.", "type": "string" }, "hyperParameters": { "$ref": "GoogleCloudAiplatformV1beta1SupervisedHyperParameters", "description": "Optional. Hyperparameters for Full Fine Tuning." } }, "description": "Tuning Spec for Full Fine Tuning." }, "GoogleCloudAiplatformV1beta1EvaluatedAnnotationExplanation": { "id": "GoogleCloudAiplatformV1beta1EvaluatedAnnotationExplanation", "description": "Explanation result of the prediction produced by the Model.", "type": "object", "properties": { "explanation": { "$ref": "GoogleCloudAiplatformV1beta1Explanation", "description": "Explanation attribution response details." }, "explanationType": { "description": "Explanation type. For AutoML Image Classification models, possible values are: * `image-integrated-gradients` * `image-xrai`", "type": "string" } } }, "GoogleCloudAiplatformV1beta1TensorboardTimeSeries": { "type": "object", "properties": { "pluginData": { "type": "string", "description": "Data of the current plugin, with the size limited to 65KB.", "format": "byte" }, "valueType": { "enumDescriptions": [ "The value type is unspecified.", "Used for TensorboardTimeSeries that is a list of scalars. E.g. accuracy of a model over epochs/time.", "Used for TensorboardTimeSeries that is a list of tensors. E.g. histograms of weights of layer in a model over epoch/time.", "Used for TensorboardTimeSeries that is a list of blob sequences. E.g. set of sample images with labels over epochs/time." ], "description": "Required. Immutable. Type of TensorboardTimeSeries value.", "enum": [ "VALUE_TYPE_UNSPECIFIED", "SCALAR", "TENSOR", "BLOB_SEQUENCE" ], "type": "string" }, "description": { "description": "Description of this TensorboardTimeSeries.", "type": "string" }, "createTime": { "description": "Output only. Timestamp when this TensorboardTimeSeries was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "name": { "type": "string", "description": "Output only. Name of the TensorboardTimeSeries.", "readOnly": true }, "metadata": { "$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeriesMetadata", "readOnly": true, "description": "Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries." }, "displayName": { "description": "Required. User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).", "type": "string" }, "etag": { "description": "Used to perform a consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "type": "string" }, "pluginName": { "description": "Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob", "type": "string" }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Timestamp when this TensorboardTimeSeries was last updated.", "type": "string" } }, "description": "TensorboardTimeSeries maps to times series produced in training runs", "id": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" }, "GoogleCloudAiplatformV1beta1PurgeArtifactsResponse": { "description": "Response message for MetadataService.PurgeArtifacts.", "type": "object", "properties": { "purgeCount": { "description": "The number of Artifacts that this request deleted (or, if `force` is false, the number of Artifacts that will be deleted). This can be an estimate.", "format": "int64", "type": "string" }, "purgeSample": { "items": { "type": "string" }, "type": "array", "description": "A sample of the Artifact names that will be deleted. Only populated if `force` is set to false. The maximum number of samples is 100 (it is possible to return fewer)." } }, "id": "GoogleCloudAiplatformV1beta1PurgeArtifactsResponse" }, "GoogleCloudAiplatformV1beta1FasterDeploymentConfig": { "id": "GoogleCloudAiplatformV1beta1FasterDeploymentConfig", "type": "object", "description": "Configuration for faster model deployment.", "properties": { "fastTryoutEnabled": { "description": "If true, enable fast tryout feature for this deployed model.", "type": "boolean" } } }, "GoogleCloudAiplatformV1beta1ActivateOnlineEvaluatorRequest": { "id": "GoogleCloudAiplatformV1beta1ActivateOnlineEvaluatorRequest", "description": "Request message for ActivateOnlineEvaluator.", "type": "object", "properties": {} }, "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestInteractionsSource": { "id": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestInteractionsSource", "description": "Source for importing interactions from the Interactions API into an EvaluationSet. The agent identity is specified once, with a list of interaction IDs to import.", "type": "object", "properties": { "geminiAgentConfig": { "description": "Optional. Gemini Agent (Vertex AI Agent resource).", "$ref": "GoogleCloudAiplatformV1beta1GeminiAgentConfig" }, "interactions": { "description": "Required. The interactions to import. Format: `projects/{project}/locations/{location}/interactions/{interaction}`.", "items": { "type": "string" }, "type": "array" } } }, "GoogleCloudAiplatformV1beta1ToolUseExample": { "properties": { "requestParams": { "description": "Request parameters used for executing this tool.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "query": { "type": "string", "description": "Required. Query that should be routed to this tool." }, "extensionOperation": { "$ref": "GoogleCloudAiplatformV1beta1ToolUseExampleExtensionOperation", "description": "Extension operation to call." }, "functionName": { "description": "Function name to call.", "type": "string" }, "responseSummary": { "description": "Summary of the tool response to the user query.", "type": "string" }, "responseParams": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "Response parameters generated by this tool." }, "displayName": { "type": "string", "description": "Required. The display name for example." } }, "type": "object", "description": "A single example of the tool usage.", "id": "GoogleCloudAiplatformV1beta1ToolUseExample" }, "GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadataInputConfig": { "properties": { "bigquerySource": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadataBigQuerySource" }, "gcsSource": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadataGcsSource" } }, "type": "object", "description": "The tables Dataset's data source. The Dataset doesn't store the data directly, but only pointer(s) to its data.", "id": "GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadataInputConfig" }, "GoogleCloudAiplatformV1beta1NasJobSpecMultiTrialAlgorithmSpec": { "type": "object", "id": "GoogleCloudAiplatformV1beta1NasJobSpecMultiTrialAlgorithmSpec", "properties": { "metric": { "$ref": "GoogleCloudAiplatformV1beta1NasJobSpecMultiTrialAlgorithmSpecMetricSpec", "description": "Metric specs for the NAS job. Validation for this field is done at `multi_trial_algorithm_spec` field." }, "searchTrialSpec": { "$ref": "GoogleCloudAiplatformV1beta1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec", "description": "Required. Spec for search trials." }, "trainTrialSpec": { "$ref": "GoogleCloudAiplatformV1beta1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec", "description": "Spec for train trials. Top N [TrainTrialSpec.max_parallel_trial_count] search trials will be trained for every M [TrainTrialSpec.frequency] trials searched." }, "multiTrialAlgorithm": { "enumDescriptions": [ "Defaults to `REINFORCEMENT_LEARNING`.", "The Reinforcement Learning Algorithm for Multi-trial Neural Architecture Search (NAS).", "The Grid Search Algorithm for Multi-trial Neural Architecture Search (NAS)." ], "description": "The multi-trial Neural Architecture Search (NAS) algorithm type. Defaults to `REINFORCEMENT_LEARNING`.", "type": "string", "enum": [ "MULTI_TRIAL_ALGORITHM_UNSPECIFIED", "REINFORCEMENT_LEARNING", "GRID_SEARCH" ] } }, "description": "The spec of multi-trial Neural Architecture Search (NAS)." }, "GoogleCloudAiplatformV1beta1MetadataSchema": { "properties": { "schemaType": { "enum": [ "METADATA_SCHEMA_TYPE_UNSPECIFIED", "ARTIFACT_TYPE", "EXECUTION_TYPE", "CONTEXT_TYPE" ], "type": "string", "enumDescriptions": [ "Unspecified type for the MetadataSchema.", "A type indicating that the MetadataSchema will be used by Artifacts.", "A typee indicating that the MetadataSchema will be used by Executions.", "A state indicating that the MetadataSchema will be used by Contexts." ], "description": "The type of the MetadataSchema. This is a property that identifies which metadata types will use the MetadataSchema." }, "description": { "type": "string", "description": "Description of the Metadata Schema" }, "createTime": { "description": "Output only. Timestamp when this MetadataSchema was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "schema": { "description": "Required. The raw YAML string representation of the MetadataSchema. The combination of [MetadataSchema.version] and the schema name given by `title` in [MetadataSchema.schema] must be unique within a MetadataStore. The schema is defined as an OpenAPI 3.0.2 [MetadataSchema Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject)", "type": "string" }, "name": { "description": "Output only. The resource name of the MetadataSchema.", "readOnly": true, "type": "string" }, "schemaVersion": { "description": "The version of the MetadataSchema. The version's format must match the following regular expression: `^[0-9]+.+.+$`, which would allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc.", "type": "string" } }, "type": "object", "description": "Instance of a general MetadataSchema.", "id": "GoogleCloudAiplatformV1beta1MetadataSchema" }, "GoogleCloudAiplatformV1beta1ListEvaluationMetricsResponse": { "id": "GoogleCloudAiplatformV1beta1ListEvaluationMetricsResponse", "description": "Response message for EvaluationMetricService.ListEvaluationMetrics.", "type": "object", "properties": { "evaluationMetrics": { "type": "array", "description": "List of EvaluationMetrics in the requested page.", "items": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationMetric" } }, "nextPageToken": { "description": "A token to retrieve the next page of results.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1BatchMigrateResourcesResponse": { "id": "GoogleCloudAiplatformV1beta1BatchMigrateResourcesResponse", "description": "Response message for MigrationService.BatchMigrateResources.", "type": "object", "properties": { "migrateResourceResponses": { "type": "array", "description": "Successfully migrated resources.", "items": { "$ref": "GoogleCloudAiplatformV1beta1MigrateResourceResponse" } } } }, "GoogleCloudAiplatformV1beta1RagVectorDbConfigPinecone": { "type": "object", "description": "The config for the Pinecone.", "properties": { "indexName": { "description": "Pinecone index name. This value cannot be changed after it's set.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1RagVectorDbConfigPinecone" }, "GoogleCloudAiplatformV1beta1AgentEvent": { "type": "object", "properties": { "content": { "description": "Required. The content of the event (e.g., text response, tool call, tool response).", "$ref": "GoogleCloudAiplatformV1beta1Content" }, "activeTools": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Tool" }, "description": "Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set.", "type": "array" }, "author": { "type": "string", "description": "Required. The ID of the agent or entity that generated this event. Use \"user\" to denote events generated by the end-user." }, "stateDelta": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event." }, "eventTime": { "type": "string", "description": "Optional. The timestamp when the event occurred.", "format": "google-datetime" } }, "description": "Represents a single event in the execution trace.", "id": "GoogleCloudAiplatformV1beta1AgentEvent" }, "GoogleCloudAiplatformV1beta1ExecuteCodeResponse": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ExecuteCodeResponse", "properties": { "outputs": { "description": "The outputs from the sandbox environment.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Chunk" } } }, "description": "Response message for SandboxEnvironmentExecutionService.ExecuteCode." }, "GoogleCloudAiplatformV1beta1ListMetadataStoresResponse": { "properties": { "metadataStores": { "type": "array", "description": "The MetadataStores found for the Location.", "items": { "$ref": "GoogleCloudAiplatformV1beta1MetadataStore" } }, "nextPageToken": { "description": "A token, which can be sent as ListMetadataStoresRequest.page_token to retrieve the next page. If this field is not populated, there are no subsequent pages.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1ListMetadataStoresResponse", "description": "Response message for MetadataService.ListMetadataStores.", "type": "object" }, "GoogleCloudAiplatformV1beta1RecommendSpecRequest": { "type": "object", "id": "GoogleCloudAiplatformV1beta1RecommendSpecRequest", "properties": { "checkUserQuota": { "description": "Optional. If true, check user quota for the recommended regions. Returns all the machine spec in regions they are available, and also the user quota state for each machine type in each region.", "type": "boolean" }, "checkMachineAvailability": { "type": "boolean", "description": "Optional. If true, check machine availability for the recommended regions. Only return the machine spec in regions where the machine is available." }, "gcsUri": { "description": "Required. The Google Cloud Storage URI of the custom model, storing weights and config files (which can be used to infer the base model).", "type": "string" } }, "description": "Request message for ModelService.RecommendSpec." }, "GoogleCloudAiplatformV1beta1ModelMonitoringInput": { "description": "Model monitoring data input spec.", "type": "object", "properties": { "vertexEndpointLogs": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringInputVertexEndpointLogs", "description": "Vertex AI Endpoint request & response logging." }, "timeInterval": { "$ref": "GoogleTypeInterval", "description": "The time interval (pair of start_time and end_time) for which results should be returned." }, "batchPredictionOutput": { "description": "Vertex AI Batch prediction Job.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringInputBatchPredictionOutput" }, "timeOffset": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringInputTimeOffset", "description": "The time offset setting for which results should be returned." }, "columnizedDataset": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringInputModelMonitoringDataset", "description": "Columnized dataset." } }, "id": "GoogleCloudAiplatformV1beta1ModelMonitoringInput" }, "GoogleCloudAiplatformV1beta1ExactMatchResults": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ExactMatchResults", "properties": { "exactMatchMetricValues": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1ExactMatchMetricValue" }, "readOnly": true, "description": "Output only. Exact match metric values." } }, "description": "Results for exact match metric." }, "GoogleCloudAiplatformV1beta1ContentMap": { "properties": { "values": { "description": "Optional. Map of placeholder to contents.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1ContentMapContents" } } }, "description": "Map of placeholder in metric prompt template to contents of model input.", "type": "object", "id": "GoogleCloudAiplatformV1beta1ContentMap" }, "GoogleCloudAiplatformV1beta1CsvDestination": { "properties": { "gcsDestination": { "description": "Required. Google Cloud Storage location.", "$ref": "GoogleCloudAiplatformV1beta1GcsDestination" } }, "id": "GoogleCloudAiplatformV1beta1CsvDestination", "type": "object", "description": "The storage details for CSV output content." }, "GoogleCloudAiplatformV1beta1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame": { "properties": { "timeOffset": { "description": "A time (frame) of a video in which the object has been detected. Expressed as a number of seconds as measured from the start of the video, with fractions up to a microsecond precision, and with \"s\" appended at the end.", "format": "google-duration", "type": "string" }, "yMin": { "format": "float", "type": "number", "description": "The topmost coordinate of the bounding box." }, "xMin": { "format": "float", "type": "number", "description": "The leftmost coordinate of the bounding box." }, "xMax": { "format": "float", "type": "number", "description": "The rightmost coordinate of the bounding box." }, "yMax": { "format": "float", "type": "number", "description": "The bottommost coordinate of the bounding box." } }, "id": "GoogleCloudAiplatformV1beta1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame", "type": "object", "description": "The fields `xMin`, `xMax`, `yMin`, and `yMax` refer to a bounding box, i.e. the rectangle over the video frame pinpointing the found AnnotationSpec. The coordinates are relative to the frame size, and the point 0,0 is in the top left of the frame." }, "GoogleCloudAiplatformV1beta1MetadataValue": { "id": "GoogleCloudAiplatformV1beta1MetadataValue", "description": "Value of Metadata, including all types available in data schema.", "type": "object", "properties": { "floatValue": { "type": "number", "description": "Value of float type metadata.", "format": "float" }, "datetimeValue": { "type": "string", "description": "Value of date time type metadata." }, "strValue": { "type": "string", "description": "Value of string type metadata." }, "boolValue": { "type": "boolean", "description": "Value of boolean type metadata." }, "intValue": { "description": "Value of int type metadata.", "format": "int64", "type": "string" }, "listValue": { "description": "Value of list type metadata.", "$ref": "GoogleCloudAiplatformV1beta1MetadataList" } } }, "GoogleCloudAiplatformV1beta1TrajectorySingleToolUseInstance": { "id": "GoogleCloudAiplatformV1beta1TrajectorySingleToolUseInstance", "type": "object", "properties": { "predictedTrajectory": { "description": "Required. Spec for predicted tool call trajectory.", "$ref": "GoogleCloudAiplatformV1beta1Trajectory" } }, "description": "Spec for TrajectorySingleToolUse instance." }, "GoogleCloudAiplatformV1beta1MigratableResourceMlEngineModelVersion": { "id": "GoogleCloudAiplatformV1beta1MigratableResourceMlEngineModelVersion", "type": "object", "properties": { "endpoint": { "description": "The ml.googleapis.com endpoint that this model Version currently lives in. Example values: * ml.googleapis.com * us-centrall-ml.googleapis.com * europe-west4-ml.googleapis.com * asia-east1-ml.googleapis.com", "type": "string" }, "version": { "description": "Full resource name of ml engine model Version. Format: `projects/{project}/models/{model}/versions/{version}`.", "type": "string" } }, "description": "Represents one model Version in ml.googleapis.com." }, "GoogleCloudAiplatformV1beta1CancelAsyncQueryReasoningEngineRequest": { "type": "object", "description": "Request message for ReasoningEngineExecutionService.CancelAsyncQueryReasoningEngine.", "properties": { "operationName": { "description": "Required. The name of the longrunning operation returned from AsyncQueryReasoningEngine. Format: `projects/{project}/locations/{location}/operations/{operation}`", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1CancelAsyncQueryReasoningEngineRequest" }, "GoogleCloudAiplatformV1beta1CreateMetadataStoreOperationMetadata": { "id": "GoogleCloudAiplatformV1beta1CreateMetadataStoreOperationMetadata", "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "Operation metadata for creating a MetadataStore." } }, "description": "Details of operations that perform MetadataService.CreateMetadataStore.", "type": "object" }, "GoogleCloudAiplatformV1beta1ListDatasetsResponse": { "description": "Response message for DatasetService.ListDatasets.", "properties": { "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "datasets": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Dataset" }, "type": "array", "description": "A list of Datasets that matches the specified filter in the request." } }, "id": "GoogleCloudAiplatformV1beta1ListDatasetsResponse", "type": "object" }, "GoogleCloudAiplatformV1beta1GenerateContentRequest": { "description": "Request message for [PredictionService.GenerateContent].", "type": "object", "properties": { "labels": { "description": "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.", "additionalProperties": { "type": "string" }, "type": "object" }, "generationConfig": { "description": "Optional. Generation config.", "$ref": "GoogleCloudAiplatformV1beta1GenerationConfig" }, "contents": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" }, "type": "array", "description": "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." }, "modelArmorConfig": { "description": "Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.", "$ref": "GoogleCloudAiplatformV1beta1ModelArmorConfig" }, "tools": { "description": "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.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Tool" }, "type": "array" }, "systemInstruction": { "$ref": "GoogleCloudAiplatformV1beta1Content", "description": "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." }, "safetySettings": { "description": "Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.", "items": { "$ref": "GoogleCloudAiplatformV1beta1SafetySetting" }, "type": "array" }, "toolConfig": { "description": "Optional. Tool config. This config is shared for all tools provided in the request.", "$ref": "GoogleCloudAiplatformV1beta1ToolConfig" }, "cachedContent": { "description": "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}`", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1GenerateContentRequest" }, "GoogleCloudAiplatformV1beta1TrajectoryExactMatchInstance": { "type": "object", "id": "GoogleCloudAiplatformV1beta1TrajectoryExactMatchInstance", "properties": { "referenceTrajectory": { "description": "Required. Spec for reference tool call trajectory.", "$ref": "GoogleCloudAiplatformV1beta1Trajectory" }, "predictedTrajectory": { "description": "Required. Spec for predicted tool call trajectory.", "$ref": "GoogleCloudAiplatformV1beta1Trajectory" } }, "description": "Spec for TrajectoryExactMatch instance." }, "GoogleCloudAiplatformV1beta1SchemaPredictionResultError": { "properties": { "message": { "description": "Error message with additional details.", "type": "string" }, "status": { "description": "Error status. This will be serialized into the enum name e.g. \"NOT_FOUND\".", "enum": [ "OK", "CANCELLED", "UNKNOWN", "INVALID_ARGUMENT", "DEADLINE_EXCEEDED", "NOT_FOUND", "ALREADY_EXISTS", "PERMISSION_DENIED", "UNAUTHENTICATED", "RESOURCE_EXHAUSTED", "FAILED_PRECONDITION", "ABORTED", "OUT_OF_RANGE", "UNIMPLEMENTED", "INTERNAL", "UNAVAILABLE", "DATA_LOSS" ], "enumDescriptions": [ "Not an error; returned on success. HTTP Mapping: 200 OK", "The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request", "Unknown error. For example, this error may be returned when a `Status` value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. HTTP Mapping: 500 Internal Server Error", "The client specified an invalid argument. Note that this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). HTTP Mapping: 400 Bad Request", "The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. HTTP Mapping: 504 Gateway Timeout", "Some requested entity (e.g., file or directory) was not found. Note to server developers: if a request is denied for an entire class of users, such as gradual feature rollout or undocumented allowlist, `NOT_FOUND` may be used. If a request is denied for some users within a class of users, such as user-based access control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not Found", "The entity that a client attempted to create (e.g., file or directory) already exists. HTTP Mapping: 409 Conflict", "The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden", "The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized", "Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests", "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. For example, if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", "The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict", "The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request", "The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented", "Internal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors. HTTP Mapping: 500 Internal Server Error", "The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 503 Service Unavailable", "Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal Server Error" ], "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaPredictionResultError" }, "GoogleCloudAiplatformV1beta1DeployRequestModelConfig": { "description": "The model config to use for the deployment.", "properties": { "modelDisplayName": { "description": "Optional. The user-specified display name of the uploaded model. If not set, a default name will be used.", "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" }, "huggingFaceAccessToken": { "type": "string", "description": "Optional. The Hugging Face read access token used to access the model artifacts of gated models." }, "modelUserId": { "description": "Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name. When not provided, Vertex AI will generate a value for this ID. When Model Registry model is provided, this field will be ignored. This value may be up to 63 characters, and valid characters are `[a-z0-9_-]`. The first character cannot be a number or hyphen.", "type": "string" }, "acceptEula": { "description": "Optional. Whether the user accepts the End User License Agreement (EULA) for the model.", "type": "boolean" }, "containerSpec": { "description": "Optional. The specification of the container that is to be used when deploying. If not set, the default container spec will be used.", "$ref": "GoogleCloudAiplatformV1beta1ModelContainerSpec" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1DeployRequestModelConfig" }, "GoogleCloudAiplatformV1beta1MetadataStoreMetadataStoreState": { "properties": { "diskUtilizationBytes": { "description": "The disk utilization of the MetadataStore in bytes.", "type": "string", "format": "int64" } }, "id": "GoogleCloudAiplatformV1beta1MetadataStoreMetadataStoreState", "description": "Represents state information for a MetadataStore.", "type": "object" }, "GoogleCloudAiplatformV1beta1PublisherModelConfigClaudeFeatureConfig": { "properties": { "cyberVerificationProgramEnabled": { "type": "boolean", "description": "Optional. Deprecated: use `advanced_ai_enabled` instead. Indicates whether the customer has enabled the Cyber Verification Program (CVP) for this publisher model (data retention opt-in). See b/528731813.", "deprecated": true }, "advancedAiEnabled": { "description": "Optional. Indicates whether the customer has enabled advanced AI features for this publisher model (data retention opt-in). See b/528731813. This is the source of truth; the deprecated `cyber_verification_program_enabled` is no longer consulted on read.", "type": "boolean" } }, "description": "Config for Claude-specific features.", "type": "object", "id": "GoogleCloudAiplatformV1beta1PublisherModelConfigClaudeFeatureConfig" }, "GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters": { "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters", "properties": { "samplesPerPrompt": { "type": "integer", "description": "Optional. Number of different responses to generate per prompt during tuning.", "format": "int32" }, "evaluateInterval": { "description": "Optional. How often at steps to evaluate the tuning job during training. If not set, evel will be run per epoch. `total_steps = epoch_count * samples_per_prompt / total_prompts_in_dataset`", "type": "integer", "format": "int32" }, "adapterSize": { "enumDescriptions": [ "Adapter size is unspecified.", "Adapter size 1.", "Adapter size 2.", "Adapter size 4.", "Adapter size 8.", "Adapter size 16.", "Adapter size 32." ], "enum": [ "ADAPTER_SIZE_UNSPECIFIED", "ADAPTER_SIZE_ONE", "ADAPTER_SIZE_TWO", "ADAPTER_SIZE_FOUR", "ADAPTER_SIZE_EIGHT", "ADAPTER_SIZE_SIXTEEN", "ADAPTER_SIZE_THIRTY_TWO" ], "type": "string", "description": "Optional. Adapter size for Reinforcement Tuning." }, "learningRateMultiplier": { "format": "double", "description": "Optional. Learning rate multiplier for Reinforcement Tuning.", "type": "number" }, "checkpointInterval": { "format": "int32", "description": "Optional. How often at steps to save checkpoints during training. If not set, one checkpoint per epoch will be set. ```total_steps = epoch_count * samples_per_prompt / total_prompts_in_dataset```", "type": "integer" }, "thinkingLevel": { "type": "string", "enumDescriptions": [ "Unspecified thinking level.", "Little to no thinking.", "Low thinking level.", "Medium thinking level.", "High thinking level." ], "enum": [ "REINFORCEMENT_TUNING_THINKING_LEVEL_UNSPECIFIED", "MINIMAL", "LOW", "MEDIUM", "HIGH" ], "description": "Indicates the maximum thinking depth during tuning. Starting from Gemini 3.5 models, the old thinking_budget will no longer be supported and will result in a user error if set. Instead, users should use the thinking_level parameter to control the maximum thinking depth." }, "stepCount": { "type": "string", "format": "int64", "description": "Optional. Number of steps for the tuning job (mutually exclusive with epoch_count)." }, "maxOutputTokens": { "format": "int32", "type": "integer", "description": "Optional. The maximum number of tokens to generate per prompt. Default to 32768." }, "epochCount": { "type": "string", "description": "Optional. Number of training epoches for the tuning job.", "format": "int64" }, "thinkingBudget": { "format": "int32", "type": "integer", "description": "Optional. The thinking budget for the tuning job to optimize for (Gemini 2.5 only). * -1 means dynamic thinking * 0 means no thinking * \u003e 0 means thinking budget in tokens If not set, default to -1 (dynamic thinking)." }, "batchSize": { "description": "Optional. Batch size for the tuning job. How many prompts to process at a train step. If not set, the batch size will be determined automatically.", "format": "int32", "type": "integer" } }, "type": "object", "description": "Hyperparameters for Reinforcement Tuning." }, "GoogleCloudAiplatformV1beta1AssessmentDetectorFinding": { "id": "GoogleCloudAiplatformV1beta1AssessmentDetectorFinding", "properties": { "severity": { "description": "The severity of the finding.", "enum": [ "SEVERITY_UNSPECIFIED", "SEVERITY_LOW", "SEVERITY_MEDIUM", "SEVERITY_HIGH", "SEVERITY_CRITICAL" ], "enumDescriptions": [ "Unspecified severity.", "Low severity.", "Medium severity.", "High severity.", "Critical severity." ], "type": "string" }, "detectorId": { "description": "The detector ID.", "type": "string" }, "displayName": { "description": "The detector display name.", "type": "string" }, "probability": { "type": "number", "format": "double", "description": "The probability that this finding is an anomaly, in the range [0.0, 1.0]." }, "recommendations": { "description": "The list of recommendations for this detector finding.", "items": { "type": "string" }, "type": "array" }, "explanation": { "type": "string", "description": "The explanation of the finding." } }, "description": "The details of a detector's assessment within an analyzed session.", "type": "object" }, "CloudAiLargeModelsVisionGenerateVideoExperimentsOutpaintConfig": { "description": "Config for Outpainting task.", "properties": { "inputFrames": { "description": "The input frames for outpainting. Required.", "items": { "$ref": "CloudAiLargeModelsVisionGenerateVideoExperimentsOutpaintConfigFrameSource" }, "type": "array" }, "outputSpec": { "enum": [ "OUTPUT_SPEC_UNSPECIFIED", "OUTPUT_SPEC_1920X1072x72", "OUTPUT_SPEC_1280X720x192", "OUTPUT_SPEC_960X544x432" ], "type": "string", "enumDescriptions": [ "", "High spec: 1920x1072 resolution, 72 total frames.", "Medium spec: 1280x720 resolution, 192 total frames.", "Low spec: 960x544 resolution, 432 total frames." ], "description": "The output specification (defines target resolution and frame count). Required." } }, "type": "object", "id": "CloudAiLargeModelsVisionGenerateVideoExperimentsOutpaintConfig" }, "GoogleCloudAiplatformV1beta1SummarizationVerbosityInput": { "id": "GoogleCloudAiplatformV1beta1SummarizationVerbosityInput", "properties": { "instance": { "$ref": "GoogleCloudAiplatformV1beta1SummarizationVerbosityInstance", "description": "Required. Summarization verbosity instance." }, "metricSpec": { "$ref": "GoogleCloudAiplatformV1beta1SummarizationVerbositySpec", "description": "Required. Spec for summarization verbosity score metric." } }, "description": "Input for summarization verbosity metric.", "type": "object" }, "GoogleCloudAiplatformV1beta1EvaluateInstancesRequest": { "type": "object", "id": "GoogleCloudAiplatformV1beta1EvaluateInstancesRequest", "description": "Request message for EvaluationService.EvaluateInstances.", "properties": { "groundednessInput": { "description": "Input for groundedness metric.", "$ref": "GoogleCloudAiplatformV1beta1GroundednessInput" }, "rubricBasedInstructionFollowingInput": { "description": "Rubric Based Instruction Following metric.", "$ref": "GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingInput" }, "trajectoryInOrderMatchInput": { "$ref": "GoogleCloudAiplatformV1beta1TrajectoryInOrderMatchInput", "description": "Input for trajectory in order match metric." }, "pairwiseMetricInput": { "description": "Input for pairwise metric.", "$ref": "GoogleCloudAiplatformV1beta1PairwiseMetricInput" }, "summarizationQualityInput": { "description": "Input for summarization quality metric.", "$ref": "GoogleCloudAiplatformV1beta1SummarizationQualityInput" }, "trajectoryExactMatchInput": { "$ref": "GoogleCloudAiplatformV1beta1TrajectoryExactMatchInput", "description": "Input for trajectory exact match metric." }, "cometInput": { "description": "Translation metrics. Input for Comet metric.", "$ref": "GoogleCloudAiplatformV1beta1CometInput" }, "metricSources": { "description": "Optional. The metrics (either inline or registered) used for evaluation. Currently, we only support evaluating a single metric. If multiple metrics are provided, only the first one will be evaluated.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1MetricSource" } }, "toolNameMatchInput": { "description": "Input for tool name match metric.", "$ref": "GoogleCloudAiplatformV1beta1ToolNameMatchInput" }, "summarizationHelpfulnessInput": { "$ref": "GoogleCloudAiplatformV1beta1SummarizationHelpfulnessInput", "description": "Input for summarization helpfulness metric." }, "toolParameterKvMatchInput": { "description": "Input for tool parameter key value match metric.", "$ref": "GoogleCloudAiplatformV1beta1ToolParameterKVMatchInput" }, "rougeInput": { "$ref": "GoogleCloudAiplatformV1beta1RougeInput", "description": "Instances and metric spec for rouge metric." }, "questionAnsweringRelevanceInput": { "description": "Input for question answering relevance metric.", "$ref": "GoogleCloudAiplatformV1beta1QuestionAnsweringRelevanceInput" }, "pairwiseQuestionAnsweringQualityInput": { "description": "Input for pairwise question answering quality metric.", "$ref": "GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualityInput" }, "trajectoryAnyOrderMatchInput": { "$ref": "GoogleCloudAiplatformV1beta1TrajectoryAnyOrderMatchInput", "description": "Input for trajectory match any order metric." }, "metricxInput": { "$ref": "GoogleCloudAiplatformV1beta1MetricxInput", "description": "Input for Metricx metric." }, "questionAnsweringHelpfulnessInput": { "description": "Input for question answering helpfulness metric.", "$ref": "GoogleCloudAiplatformV1beta1QuestionAnsweringHelpfulnessInput" }, "coherenceInput": { "description": "Input for coherence metric.", "$ref": "GoogleCloudAiplatformV1beta1CoherenceInput" }, "instance": { "description": "The instance to be evaluated.", "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstance" }, "autoraterConfig": { "$ref": "GoogleCloudAiplatformV1beta1AutoraterConfig", "description": "Optional. Autorater config used for evaluation. Not applicable for predefined metrics (PredefinedMetricSpec); the server uses its own model configuration for predefined metrics and this field is ignored." }, "pairwiseSummarizationQualityInput": { "$ref": "GoogleCloudAiplatformV1beta1PairwiseSummarizationQualityInput", "description": "Input for pairwise summarization quality metric." }, "metrics": { "description": "The metrics used for evaluation. Currently, we only support evaluating a single metric. If multiple metrics are provided, only the first one will be evaluated.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Metric" } }, "summarizationVerbosityInput": { "description": "Input for summarization verbosity metric.", "$ref": "GoogleCloudAiplatformV1beta1SummarizationVerbosityInput" }, "toolCallValidInput": { "$ref": "GoogleCloudAiplatformV1beta1ToolCallValidInput", "description": "Tool call metric instances. Input for tool call valid metric." }, "pointwiseMetricInput": { "$ref": "GoogleCloudAiplatformV1beta1PointwiseMetricInput", "description": "Input for pointwise metric." }, "trajectoryRecallInput": { "$ref": "GoogleCloudAiplatformV1beta1TrajectoryRecallInput", "description": "Input for trajectory recall metric." }, "questionAnsweringQualityInput": { "$ref": "GoogleCloudAiplatformV1beta1QuestionAnsweringQualityInput", "description": "Input for question answering quality metric." }, "toolParameterKeyMatchInput": { "description": "Input for tool parameter key match metric.", "$ref": "GoogleCloudAiplatformV1beta1ToolParameterKeyMatchInput" }, "exactMatchInput": { "$ref": "GoogleCloudAiplatformV1beta1ExactMatchInput", "description": "Auto metric instances. Instances and metric spec for exact match metric." }, "fluencyInput": { "$ref": "GoogleCloudAiplatformV1beta1FluencyInput", "description": "LLM-based metric instance. General text generation metrics, applicable to other categories. Input for fluency metric." }, "trajectoryPrecisionInput": { "$ref": "GoogleCloudAiplatformV1beta1TrajectoryPrecisionInput", "description": "Input for trajectory precision metric." }, "bleuInput": { "description": "Instances and metric spec for bleu metric.", "$ref": "GoogleCloudAiplatformV1beta1BleuInput" }, "safetyInput": { "description": "Input for safety metric.", "$ref": "GoogleCloudAiplatformV1beta1SafetyInput" }, "questionAnsweringCorrectnessInput": { "$ref": "GoogleCloudAiplatformV1beta1QuestionAnsweringCorrectnessInput", "description": "Input for question answering correctness metric." }, "fulfillmentInput": { "description": "Input for fulfillment metric.", "$ref": "GoogleCloudAiplatformV1beta1FulfillmentInput" }, "location": { "type": "string", "description": "Required. The resource name of the Location to evaluate the instances. Format: `projects/{project}/locations/{location}`" }, "trajectorySingleToolUseInput": { "description": "Input for trajectory single tool use metric.", "$ref": "GoogleCloudAiplatformV1beta1TrajectorySingleToolUseInput" } } }, "GoogleCloudAiplatformV1beta1SpeechConfig": { "properties": { "multiSpeakerVoiceConfig": { "description": "The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.", "$ref": "GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig" }, "voiceConfig": { "$ref": "GoogleCloudAiplatformV1beta1VoiceConfig", "description": "The configuration for the voice to use." }, "languageCode": { "description": "Optional. The language code (ISO 639-1) for the speech synthesis.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1SpeechConfig", "description": "Configuration for speech generation.", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsForecastingEvaluationMetrics": { "description": "Metrics for forecasting evaluation results.", "properties": { "rSquared": { "format": "float", "type": "number", "description": "Coefficient of determination as Pearson correlation coefficient. Undefined when ground truth or predictions are constant or near constant." }, "rootMeanSquaredPercentageError": { "description": "Root Mean Square Percentage Error. Square root of MSPE. Undefined/imaginary when MSPE is negative.", "type": "number", "format": "float" }, "meanAbsolutePercentageError": { "type": "number", "format": "float", "description": "Mean absolute percentage error. Infinity when there are zeros in the ground truth." }, "meanAbsoluteError": { "format": "float", "type": "number", "description": "Mean Absolute Error (MAE)." }, "rootMeanSquaredError": { "format": "float", "description": "Root Mean Squared Error (RMSE).", "type": "number" }, "weightedAbsolutePercentageError": { "description": "Weighted Absolute Percentage Error. Does not use weights, this is just what the metric is called. Undefined if actual values sum to zero. Will be very large if actual values sum to a very small number.", "type": "number", "format": "float" }, "quantileMetrics": { "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry" }, "type": "array", "description": "The quantile metrics entries for each quantile." }, "rootMeanSquaredLogError": { "type": "number", "format": "float", "description": "Root mean squared log error. Undefined when there are negative ground truth values or predictions." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsForecastingEvaluationMetrics" }, "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsTrackMetrics": { "description": "UNIMPLEMENTED. Track matching model metrics for a single track match threshold and multiple label match confidence thresholds.", "properties": { "confidenceMetrics": { "description": "Metrics for each label-match `confidenceThreshold` from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is derived from them.", "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics" }, "type": "array" }, "meanTrackingAveragePrecision": { "description": "The mean average precision over all confidence thresholds.", "format": "float", "type": "number" }, "meanMismatchRate": { "type": "number", "description": "The mean mismatch rate over all confidence thresholds.", "format": "float" }, "meanBoundingBoxIou": { "type": "number", "description": "The mean bounding box iou over all confidence thresholds.", "format": "float" }, "iouThreshold": { "type": "number", "format": "float", "description": "The intersection-over-union threshold value between bounding boxes across frames used to compute this metric entry." } }, "id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsTrackMetrics", "type": "object" }, "GoogleCloudAiplatformV1beta1QueryDeployedModelsResponse": { "description": "Response message for QueryDeployedModels method.", "properties": { "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "deployedModels": { "description": "DEPRECATED Use deployed_model_refs instead.", "items": { "$ref": "GoogleCloudAiplatformV1beta1DeployedModel" }, "type": "array", "deprecated": true }, "totalEndpointCount": { "description": "The total number of Endpoints that have DeployedModels on this DeploymentResourcePool.", "format": "int32", "type": "integer" }, "totalDeployedModelCount": { "description": "The total number of DeployedModels on this DeploymentResourcePool.", "format": "int32", "type": "integer" }, "deployedModelRefs": { "description": "References to the DeployedModels that share the specified deploymentResourcePool.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1DeployedModelRef" } } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1QueryDeployedModelsResponse" }, "GoogleCloudAiplatformV1beta1UpdateFeaturestoreOperationMetadata": { "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "Operation metadata for Featurestore." } }, "id": "GoogleCloudAiplatformV1beta1UpdateFeaturestoreOperationMetadata", "description": "Details of operations that perform update Featurestore.", "type": "object" }, "GoogleCloudAiplatformV1beta1SlackSourceSlackChannelsSlackChannel": { "properties": { "endTime": { "format": "google-datetime", "type": "string", "description": "Optional. The ending timestamp for messages to import." }, "startTime": { "description": "Optional. The starting timestamp for messages to import.", "format": "google-datetime", "type": "string" }, "channelId": { "description": "Required. The Slack channel ID.", "type": "string" } }, "description": "SlackChannel contains the Slack channel ID and the time range to import.", "type": "object", "id": "GoogleCloudAiplatformV1beta1SlackSourceSlackChannelsSlackChannel" }, "GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageHints": { "type": "object", "id": "GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageHints", "description": "Deprecated: Use top-level `language_codes` instead. Provides hints to the model about possible languages present in the audio.", "deprecated": true, "properties": { "languageCodes": { "deprecated": true, "description": "Required. Deprecated: Use top-level `language_codes` instead. BCP-47 language codes. At least one must be specified.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudAiplatformV1beta1ImportFeatureValuesOperationMetadata": { "properties": { "importedEntityCount": { "description": "Number of entities that have been imported by the operation.", "type": "string", "format": "int64" }, "importedFeatureValueCount": { "description": "Number of Feature values that have been imported by the operation.", "type": "string", "format": "int64" }, "blockingOperationIds": { "description": "List of ImportFeatureValues operations running under a single EntityType that are blocking this operation.", "type": "array", "items": { "type": "string", "format": "int64" } }, "sourceUris": { "description": "The source URI from where Feature values are imported.", "type": "array", "items": { "type": "string" } }, "genericMetadata": { "description": "Operation metadata for Featurestore import Feature values.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" }, "invalidRowCount": { "type": "string", "format": "int64", "description": "The number of rows in input source that weren't imported due to either * Not having any featureValues. * Having a null entityId. * Having a null timestamp. * Not being parsable (applicable for CSV sources)." }, "timestampOutsideRetentionRowsCount": { "type": "string", "format": "int64", "description": "The number rows that weren't ingested due to having timestamps outside the retention boundary." } }, "description": "Details of operations that perform import Feature values.", "id": "GoogleCloudAiplatformV1beta1ImportFeatureValuesOperationMetadata", "type": "object" }, "GoogleCloudAiplatformV1beta1EvaluationInstance": { "description": "A single instance to be evaluated. Instances are used to specify the input data for evaluation, from simple string comparisons to complex, multi-turn model evaluations", "type": "object", "properties": { "otherData": { "description": "Optional. Other data used to populate placeholders based on their key. If a key conflicts with a field in the EvaluationInstance (e.g. `prompt`), the value of the field will take precedence over the value in other_data.", "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceMapInstance" }, "interactionsDataSource": { "description": "Optional. Source for populating `AgentData` from an Interactions API interaction. If set, no other agent data source fields (`cloud_trace_agent_data_source`, `agent_eval_data`, `agent_data`) may be set. The request will be rejected with INVALID_ARGUMENT if multiple agent data sources are provided.", "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceInteractionsDataSource" }, "agentEvalData": { "$ref": "GoogleCloudAiplatformV1beta1AgentData", "description": "Optional. Data used for agent evaluation." }, "reference": { "description": "Optional. Data used to populate placeholder `reference` in a metric prompt template.", "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData" }, "rubricGroups": { "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1RubricGroup" }, "description": "Optional. Named groups of rubrics associated with the prompt. This is used for rubric-based evaluations where rubrics can be referenced by a key. The key could represent versions, associated metrics, etc.", "type": "object" }, "response": { "description": "Optional. Data used to populate placeholder `response` in a metric prompt template.", "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData" }, "agentData": { "deprecated": true, "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentData", "description": "Optional. Deprecated: Use `agent_eval_data` instead. Data used for agent evaluation." }, "prompt": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData", "description": "Optional. Data used to populate placeholder `prompt` in a metric prompt template." } }, "id": "GoogleCloudAiplatformV1beta1EvaluationInstance" }, "GoogleCloudAiplatformV1beta1ListSkillsResponse": { "id": "GoogleCloudAiplatformV1beta1ListSkillsResponse", "type": "object", "properties": { "skills": { "type": "array", "description": "The Skills.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Skill" } }, "nextPageToken": { "type": "string", "description": "A token, which can be sent as ListSkillsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages." } }, "description": "Response message for SkillRegistryService.ListSkills." }, "GoogleCloudAiplatformV1beta1ListFeedbackEntriesResponse": { "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "A token to retrieve the next page. Absence of this field indicates there are no subsequent pages." }, "feedbackEntries": { "type": "array", "description": "The page of FeedbackEntries matching the request.", "items": { "$ref": "GoogleCloudAiplatformV1beta1FeedbackEntry" } } }, "id": "GoogleCloudAiplatformV1beta1ListFeedbackEntriesResponse", "description": "Response message for ListFeedbackEntries." }, "GenaiVertexV1beta1GoogleSearchCallStepGoogleSearchCallStepArguments": { "id": "GenaiVertexV1beta1GoogleSearchCallStepGoogleSearchCallStepArguments", "type": "object", "properties": { "queries": { "type": "array", "description": "Web search queries for the following-up web search.", "items": { "type": "string" } } }, "description": "The arguments to pass to Google Search." }, "GoogleCloudAiplatformV1beta1AggregationOutput": { "id": "GoogleCloudAiplatformV1beta1AggregationOutput", "type": "object", "description": "The aggregation result for the entire dataset and all metrics.", "properties": { "aggregationResults": { "items": { "$ref": "GoogleCloudAiplatformV1beta1AggregationResult" }, "type": "array", "description": "One AggregationResult per metric." }, "dataset": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationDataset", "description": "The dataset used for evaluation & aggregation." } } }, "GoogleCloudAiplatformV1beta1ModelExportFormat": { "properties": { "exportableContents": { "readOnly": true, "type": "array", "description": "Output only. The content of this Model that may be exported.", "items": { "type": "string", "enum": [ "EXPORTABLE_CONTENT_UNSPECIFIED", "ARTIFACT", "IMAGE" ], "enumDescriptions": [ "Should not be used.", "Model artifact and any of its supported files. Will be exported to the location specified by the `artifactDestination` field of the ExportModelRequest.output_config object.", "The container image that is to be used when deploying this Model. Will be exported to the location specified by the `imageDestination` field of the ExportModelRequest.output_config object." ] } }, "id": { "description": "Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. * `genie` A tuned Model Garden model.", "type": "string", "readOnly": true } }, "id": "GoogleCloudAiplatformV1beta1ModelExportFormat", "description": "Represents export format supported by the Model. All formats export to Google Cloud Storage.", "type": "object" }, "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilitySessionScope": { "properties": { "filter": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilitySessionScopePredicate" }, "description": "Optional. A list of predicates to filter sessions. Multiple predicates are combined using AND. The maximum number of predicates is 10." }, "inactivityTrigger": { "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilitySessionScopeInactivityTrigger", "description": "Session is considered ready for evaluation when there are no new traces for a specified period of inactivity." } }, "description": "If chosen, the online evaluator will evaluate sessions matching specified `filter`. A session is a group of traces with a common `gen_ai.conversation.id`.", "id": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilitySessionScope", "type": "object" }, "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigSparseEmbeddingConfig": { "description": "Configuration for sparse emebdding generation.", "properties": { "bm25": { "$ref": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigSparseEmbeddingConfigBm25", "description": "Use BM25 scoring algorithm." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigSparseEmbeddingConfig" }, "GoogleCloudAiplatformV1beta1StudySpecParameterSpecConditionalParameterSpecIntValueCondition": { "type": "object", "id": "GoogleCloudAiplatformV1beta1StudySpecParameterSpecConditionalParameterSpecIntValueCondition", "description": "Represents the spec to match integer values from parent parameter.", "properties": { "values": { "items": { "type": "string", "format": "int64" }, "description": "Required. Matches values of the parent parameter of 'INTEGER' type. All values must lie in `integer_value_spec` of parent parameter.", "type": "array" } } }, "GoogleCloudAiplatformV1beta1ExtensionManifest": { "description": "Manifest spec of an Extension needed for runtime execution.", "properties": { "apiSpec": { "description": "Required. Immutable. The API specification shown to the LLM.", "$ref": "GoogleCloudAiplatformV1beta1ExtensionManifestApiSpec" }, "authConfig": { "description": "Required. Immutable. Type of auth supported by this extension.", "$ref": "GoogleCloudAiplatformV1beta1AuthConfig" }, "name": { "description": "Required. Extension name shown to the LLM. The name can be up to 128 characters long.", "type": "string" }, "description": { "type": "string", "description": "Required. The natural language description shown to the LLM. It should describe the usage of the extension, and is essential for the LLM to perform reasoning. e.g., if the extension is a data store, you can let the LLM know what data it contains." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ExtensionManifest" }, "GoogleCloudAiplatformV1beta1ListIndexesResponse": { "properties": { "nextPageToken": { "type": "string", "description": "A token to retrieve next page of results. Pass to ListIndexesRequest.page_token to obtain that page." }, "indexes": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Index" }, "type": "array", "description": "List of indexes in the requested page." } }, "description": "Response message for IndexService.ListIndexes.", "id": "GoogleCloudAiplatformV1beta1ListIndexesResponse", "type": "object" }, "GoogleCloudAiplatformV1beta1NasJobOutput": { "type": "object", "id": "GoogleCloudAiplatformV1beta1NasJobOutput", "properties": { "multiTrialJobOutput": { "description": "Output only. The output of this multi-trial Neural Architecture Search (NAS) job.", "$ref": "GoogleCloudAiplatformV1beta1NasJobOutputMultiTrialJobOutput", "readOnly": true } }, "description": "Represents a uCAIP NasJob output." }, "GoogleCloudAiplatformV1beta1PublisherModelParent": { "properties": { "displayName": { "description": "Required. The display name of the parent. E.g., LaMDA, T5, Vision API, Natural Language API.", "type": "string" }, "reference": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelResourceReference", "description": "Optional. The Google Cloud resource name or the URI reference." } }, "id": "GoogleCloudAiplatformV1beta1PublisherModelParent", "type": "object", "description": "The information about the parent of a model." }, "GoogleCloudAiplatformV1beta1SchemaPromptSpecInteractionData": { "description": "Defines data for an interaction prompt.", "properties": { "interactionIds": { "description": "Optional. Lists interaction IDs associated with the prompt. This maps 1:1 to PromptMessage.contents. If InteractionData is present, every prompt message has an interaction ID.", "items": { "type": "string" }, "type": "array" } }, "id": "GoogleCloudAiplatformV1beta1SchemaPromptSpecInteractionData", "type": "object" }, "GoogleCloudAiplatformV1beta1A2ATaskRecordArtifactChange": { "description": "An event payload describing a change to one of the task's artifacts.", "properties": { "append": { "description": "Optional. Whether the artifact parts should be appended to an existing artifact rather than replacing it.", "type": "boolean" }, "artifact": { "description": "Required. The artifact that was added or updated.", "$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordArtifact" }, "lastChunk": { "description": "Optional. Whether this is the last chunk of a streamed artifact.", "type": "boolean" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1A2ATaskRecordArtifactChange" }, "GoogleCloudAiplatformV1beta1Example": { "id": "GoogleCloudAiplatformV1beta1Example", "type": "object", "properties": { "displayName": { "description": "Optional. The display name for Example.", "type": "string" }, "storedContentsExample": { "$ref": "GoogleCloudAiplatformV1beta1StoredContentsExample", "description": "An example of chat history and its expected outcome to be used with GenerateContent." }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. Timestamp when this Example was created.", "format": "google-datetime" }, "exampleId": { "type": "string", "description": "Optional. Immutable. Unique identifier of an example. If not specified when upserting new examples, the example_id will be generated." } } }, "GoogleCloudAiplatformV1beta1ToolParameterKeyMatchInstance": { "description": "Spec for tool parameter key match instance.", "properties": { "prediction": { "description": "Required. Output of the evaluated model.", "type": "string" }, "reference": { "description": "Required. Ground truth used to compare against the prediction.", "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ToolParameterKeyMatchInstance" }, "GenaiVertexV1beta1GoogleMapsResultStepGoogleMapsResultItem": { "id": "GenaiVertexV1beta1GoogleMapsResultStepGoogleMapsResultItem", "description": "The result of the Google Maps.", "type": "object", "properties": { "places": { "type": "array", "items": { "$ref": "GenaiVertexV1beta1GoogleMapsResultStepGoogleMapsResultItemGoogleMapsResultPlaces" } }, "widgetContextToken": { "type": "string" } } }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoClassification": { "type": "object", "description": "A TrainingJob that trains and uploads an AutoML Video Classification Model.", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoClassification", "properties": { "inputs": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs", "description": "The input parameters of this TrainingJob." } } }, "GoogleCloudAiplatformV1beta1TrajectoryPrecisionResults": { "type": "object", "properties": { "trajectoryPrecisionMetricValues": { "description": "Output only. TrajectoryPrecision metric values.", "type": "array", "readOnly": true, "items": { "$ref": "GoogleCloudAiplatformV1beta1TrajectoryPrecisionMetricValue" } } }, "description": "Results for TrajectoryPrecision metric.", "id": "GoogleCloudAiplatformV1beta1TrajectoryPrecisionResults" }, "GoogleCloudAiplatformV1beta1ListPublisherModelsResponse": { "id": "GoogleCloudAiplatformV1beta1ListPublisherModelsResponse", "description": "Response message for ModelGardenService.ListPublisherModels.", "type": "object", "properties": { "publisherModels": { "items": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModel" }, "type": "array", "description": "List of PublisherModels in the requested page." }, "nextPageToken": { "description": "A token to retrieve next page of results. Pass to ListPublisherModels.page_token to obtain that page.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs": { "properties": { "tunableParameter": { "description": "Trainer type for Vision TrainRequest.", "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter" }, "budgetMilliNodeHours": { "type": "string", "format": "int64", "description": "The training budget of creating this model, expressed in milli node hours i.e. 1,000 value in this field means 1 node hour. The actual metadata.costMilliNodeHours will be equal or less than this value. If further model training ceases to provide any improvements, it will stop without using the full budget and the metadata.successfulStopReason will be `model-converged`. Note, node_hour = actual_hour * number_of_nodes_involved. For modelType `cloud`(default), the budget must be between 20,000 and 900,000 milli node hours, inclusive. The default value is 216,000 which represents one day in wall time, considering 9 nodes are used. For model types `mobile-tf-low-latency-1`, `mobile-tf-versatile-1`, `mobile-tf-high-accuracy-1` the training budget must be between 1,000 and 100,000 milli node hours, inclusive. The default value is 24,000 which represents one day in wall time on a single node that is used." }, "disableEarlyStopping": { "description": "Use the entire training budget. This disables the early stopping feature. When false the early stopping feature is enabled, which means that AutoML Image Object Detection might stop training before the entire training budget has been used.", "type": "boolean" }, "uptrainBaseModelId": { "type": "string", "description": "The ID of `base` model for upTraining. If it is specified, the new model will be upTrained based on the `base` model for upTraining. Otherwise, the new model will be trained from scratch. The `base` model for upTraining must be in the same Project and Location as the new Model to train, and have the same modelType." }, "modelType": { "enumDescriptions": [ "Should not be set.", "A model best tailored to be used within Google Cloud, and which cannot be exported. Expected to have a higher latency, but should also have a higher prediction quality than other cloud models.", "A model best tailored to be used within Google Cloud, and which cannot be exported. Expected to have a low latency, but may have lower prediction quality than other cloud models.", "A model best tailored to be used within Google Cloud, and which cannot be exported. Compared to the CLOUD_HIGH_ACCURACY_1 and CLOUD_LOW_LATENCY_1 models above, it is expected to have higher prediction quality and lower latency.", "A model that, in addition to being available within Google Cloud can also be exported (see ModelService.ExportModel) and used on a mobile or edge device with TensorFlow afterwards. Expected to have low latency, but may have lower prediction quality than other mobile models.", "A model that, in addition to being available within Google Cloud can also be exported (see ModelService.ExportModel) and used on a mobile or edge device with TensorFlow afterwards.", "A model that, in addition to being available within Google Cloud, can also be exported (see ModelService.ExportModel) and used on a mobile or edge device with TensorFlow afterwards. Expected to have a higher latency, but should also have a higher prediction quality than other mobile models.", "A model best tailored to be used within Google Cloud, and which cannot be exported. Expected to best support predictions in streaming with lower latency and lower prediction quality than other cloud models.", "SpineNet for Model Garden training with customizable hyperparameters. Best tailored to be used within Google Cloud, and cannot be exported externally.", "YOLO for Model Garden training with customizable hyperparameters. Best tailored to be used within Google Cloud, and cannot be exported externally." ], "enum": [ "MODEL_TYPE_UNSPECIFIED", "CLOUD_HIGH_ACCURACY_1", "CLOUD_LOW_LATENCY_1", "CLOUD_1", "MOBILE_TF_LOW_LATENCY_1", "MOBILE_TF_VERSATILE_1", "MOBILE_TF_HIGH_ACCURACY_1", "CLOUD_STREAMING_1", "SPINENET", "YOLO" ], "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs" }, "GenaiVertexV1beta1GoogleMapsResultDelta": { "id": "GenaiVertexV1beta1GoogleMapsResultDelta", "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResult" }, "description": "The results of the Google Maps." } } }, "GoogleCloudAiplatformV1beta1EvaluationParserConfigCustomCodeParserConfig": { "properties": { "parsingFunction": { "type": "string", "description": "Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -\u003e list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { \"content\": {\"property\": {\"description\": \"The response is factual.\"}}, \"type\": \"FACTUALITY\", \"importance\": \"HIGH\" }, { \"content\": {\"property\": {\"description\": \"The response is fluent.\"}}, \"type\": \"FLUENCY\", \"importance\": \"MEDIUM\" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { \"score\": 0.8, \"explanation\": \"The model followed most instructions.\", \"rubric_verdicts\": [...] } ... code for result extraction and aggregation" }, "codeExecutionRegion": { "description": "Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1EvaluationParserConfigCustomCodeParserConfig", "description": "Configuration for parsing the LLM response using custom code.", "type": "object" }, "GoogleCloudAiplatformV1beta1RemoveContextChildrenRequest": { "id": "GoogleCloudAiplatformV1beta1RemoveContextChildrenRequest", "properties": { "childContexts": { "description": "The resource names of the child Contexts.", "items": { "type": "string" }, "type": "array" } }, "type": "object", "description": "Request message for MetadataService.DeleteContextChildrenRequest." }, "GenaiVertexV1beta1InteractionCompleteEvent": { "deprecated": true, "id": "GenaiVertexV1beta1InteractionCompleteEvent", "type": "object", "properties": { "interaction": { "$ref": "GenaiVertexV1beta1Interaction", "description": "Required. The completed interaction with empty outputs to reduce the payload size. Use the preceding ContentDelta events for the actual output." } } }, "GoogleCloudAiplatformV1beta1StudySpecParameterSpecIntegerValueSpec": { "id": "GoogleCloudAiplatformV1beta1StudySpecParameterSpecIntegerValueSpec", "description": "Value specification for a parameter in `INTEGER` type.", "type": "object", "properties": { "minValue": { "format": "int64", "type": "string", "description": "Required. Inclusive minimum value of the parameter." }, "maxValue": { "description": "Required. Inclusive maximum value of the parameter.", "type": "string", "format": "int64" }, "defaultValue": { "format": "int64", "description": "A default value for an `INTEGER` parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.", "type": "string" } } }, "GenaiVertexV1beta1VideoResponseFormat": { "description": "Configuration for video output format.", "type": "object", "properties": { "delivery": { "enum": [ "DELIVERY_UNSPECIFIED", "INLINE", "URI" ], "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "Video data is returned inline in the response.", "Video data is returned as a URI." ], "description": "The delivery mode for the video output." }, "resolution": { "type": "string", "description": "The video output resolution. Defaults to 720p.", "enumDescriptions": [ "Default value. This value is unused.", "360p resolution.", "720p resolution.", "1080p resolution.", "4K resolution." ], "enum": [ "RESOLUTION_UNSPECIFIED", "RESOLUTION_THREE_SIXTY_P", "RESOLUTION_SEVEN_TWENTY_P", "RESOLUTION_TEN_EIGHTY_P", "RESOLUTION_FOUR_K" ] }, "gcsUri": { "description": "The Cloud Storage URI to store the video output. Required for Vertex if delivery mode is URI.", "type": "string" }, "aspectRatio": { "type": "string", "enum": [ "ASPECT_RATIO_UNSPECIFIED", "ASPECT_RATIO_SIXTEEN_BY_NINE", "ASPECT_RATIO_NINE_BY_SIXTEEN" ], "description": "The aspect ratio for the video output.", "enumDescriptions": [ "Default value. This value is unused.", "16:9 aspect ratio.", "9:16 aspect ratio." ] }, "duration": { "type": "string", "description": "The duration for the video output.", "format": "google-duration" } }, "id": "GenaiVertexV1beta1VideoResponseFormat" }, "GoogleCloudAiplatformV1beta1ModelMonitoringConfig": { "description": "The model monitoring configuration used for Batch Prediction Job.", "properties": { "objectiveConfigs": { "description": "Model monitoring objective config.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveConfig" }, "type": "array" }, "statsAnomaliesBaseDirectory": { "description": "A Google Cloud Storage location for batch prediction model monitoring to dump statistics and anomalies. If not provided, a folder will be created in customer project to hold statistics and anomalies.", "$ref": "GoogleCloudAiplatformV1beta1GcsDestination" }, "alertConfig": { "description": "Model monitoring alert config.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringAlertConfig" }, "analysisInstanceSchemaUri": { "description": "YAML schema file uri in Cloud Storage describing the format of a single instance that you want Tensorflow Data Validation (TFDV) to analyze. If there are any data type differences between predict instance and TFDV instance, this field can be used to override the schema. For models trained with Vertex AI, this field must be set as all the fields in predict instance formatted as string.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1ModelMonitoringConfig", "type": "object" }, "GoogleCloudAiplatformV1beta1CreateEndpointOperationMetadata": { "type": "object", "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "The operation generic information." }, "deploymentStage": { "type": "string", "readOnly": true, "description": "Output only. The deployment stage of the model. Only populated if this CreateEndpoint request deploys a model at the same time.", "enumDescriptions": [ "Default value. This value is unused.", "The deployment is initializing and setting up the environment.", "The deployment is preparing the model assets.", "The deployment is creating the underlying serving cluster.", "The deployment is adding nodes to the serving cluster.", "The deployment is getting the container image for the model server.", "The deployment is starting the model server.", "The deployment is performing finalization steps.", "The deployment has terminated.", "The deployment has succeeded.", "The deployment has failed." ], "enum": [ "DEPLOYMENT_STAGE_UNSPECIFIED", "STARTING_DEPLOYMENT", "PREPARING_MODEL", "CREATING_SERVING_CLUSTER", "ADDING_NODES_TO_CLUSTER", "GETTING_CONTAINER_IMAGE", "STARTING_MODEL_SERVER", "FINISHING_UP", "DEPLOYMENT_TERMINATED", "SUCCESSFULLY_DEPLOYED", "FAILED_TO_DEPLOY" ] } }, "description": "Runtime operation information for EndpointService.CreateEndpoint.", "id": "GoogleCloudAiplatformV1beta1CreateEndpointOperationMetadata" }, "GoogleCloudAiplatformV1beta1MetricSource": { "type": "object", "properties": { "metric": { "description": "Inline metric config.", "$ref": "GoogleCloudAiplatformV1beta1Metric" }, "metricResourceName": { "description": "Optional. Resource name for registered metric.", "type": "string" } }, "description": "The metric source used for evaluation.", "id": "GoogleCloudAiplatformV1beta1MetricSource" }, "GoogleCloudAiplatformV1beta1ScheduleConfig": { "description": "Schedule configuration for the FeatureMonitor.", "properties": { "cron": { "description": "Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: \"CRON_TZ=${IANA_TIME_ZONE}\" or \"TZ=${IANA_TIME_ZONE}\". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, \"CRON_TZ=America/New_York 1 * * * *\", or \"TZ=America/New_York 1 * * * *\".", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1ScheduleConfig", "type": "object" }, "GoogleCloudAiplatformV1beta1WriteFeatureValuesResponse": { "type": "object", "properties": {}, "description": "Response message for FeaturestoreOnlineServingService.WriteFeatureValues.", "id": "GoogleCloudAiplatformV1beta1WriteFeatureValuesResponse" }, "GenaiVertexV1beta1GoogleMapsCallStepGoogleMapsCallStepArguments": { "type": "object", "id": "GenaiVertexV1beta1GoogleMapsCallStepGoogleMapsCallStepArguments", "properties": { "queries": { "description": "The queries to be executed.", "type": "array", "items": { "type": "string" } } }, "description": "The arguments to pass to the Google Maps tool." }, "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics": { "description": "Metrics for a single confidence threshold.", "properties": { "recall": { "description": "Recall under the given confidence threshold.", "type": "number", "format": "float" }, "f1Score": { "type": "number", "format": "float", "description": "The harmonic mean of recall and precision." }, "confidenceThreshold": { "type": "number", "description": "The confidence threshold value used to compute the metrics.", "format": "float" }, "precision": { "type": "number", "format": "float", "description": "Precision under the given confidence threshold." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics" }, "GoogleCloudAiplatformV1beta1StudySpec": { "description": "Represents specification of a Study.", "id": "GoogleCloudAiplatformV1beta1StudySpec", "type": "object", "properties": { "metrics": { "description": "Required. Metric specs for the Study.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1StudySpecMetricSpec" } }, "studyStoppingConfig": { "$ref": "GoogleCloudAiplatformV1beta1StudySpecStudyStoppingConfig", "description": "Conditions for automated stopping of a Study. Enable automated stopping by configuring at least one condition." }, "parameters": { "items": { "$ref": "GoogleCloudAiplatformV1beta1StudySpecParameterSpec" }, "type": "array", "description": "Required. The set of parameters to tune." }, "convexAutomatedStoppingSpec": { "$ref": "GoogleCloudAiplatformV1beta1StudySpecConvexAutomatedStoppingSpec", "description": "The automated early stopping spec using convex stopping rule." }, "decayCurveStoppingSpec": { "description": "The automated early stopping spec using decay curve rule.", "$ref": "GoogleCloudAiplatformV1beta1StudySpecDecayCurveAutomatedStoppingSpec" }, "medianAutomatedStoppingSpec": { "$ref": "GoogleCloudAiplatformV1beta1StudySpecMedianAutomatedStoppingSpec", "description": "The automated early stopping spec using median rule." }, "observationNoise": { "enumDescriptions": [ "The default noise level chosen by Vertex AI.", "Vertex AI assumes that the objective function is (nearly) perfectly reproducible, and will never repeat the same Trial parameters.", "Vertex AI will estimate the amount of noise in metric evaluations, it may repeat the same Trial parameters more than once." ], "type": "string", "description": "The observation noise level of the study. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline.", "enum": [ "OBSERVATION_NOISE_UNSPECIFIED", "LOW", "HIGH" ] }, "transferLearningConfig": { "$ref": "GoogleCloudAiplatformV1beta1StudySpecTransferLearningConfig", "description": "The configuration info/options for transfer learning. Currently supported for Vertex AI Vizier service, not HyperParameterTuningJob" }, "algorithm": { "enumDescriptions": [ "The default algorithm used by Vertex AI for [hyperparameter tuning](https://cloud.google.com/vertex-ai/docs/training/hyperparameter-tuning-overview) and [Vertex AI Vizier](https://cloud.google.com/vertex-ai/docs/vizier).", "Simple grid search within the feasible space. To use grid search, all parameters must be `INTEGER`, `CATEGORICAL`, or `DISCRETE`.", "Simple random search within the feasible space." ], "enum": [ "ALGORITHM_UNSPECIFIED", "GRID_SEARCH", "RANDOM_SEARCH" ], "description": "The search algorithm specified for the Study.", "type": "string" }, "convexStopConfig": { "$ref": "GoogleCloudAiplatformV1beta1StudySpecConvexStopConfig", "deprecated": true, "description": "Deprecated. The automated early stopping using convex stopping rule." }, "measurementSelectionType": { "enum": [ "MEASUREMENT_SELECTION_TYPE_UNSPECIFIED", "LAST_MEASUREMENT", "BEST_MEASUREMENT" ], "type": "string", "description": "Describe which measurement selection type will be used", "enumDescriptions": [ "Will be treated as LAST_MEASUREMENT.", "Use the last measurement reported.", "Use the best measurement reported." ] } } }, "GoogleCloudAiplatformV1beta1ListNasTrialDetailsResponse": { "properties": { "nasTrialDetails": { "items": { "$ref": "GoogleCloudAiplatformV1beta1NasTrialDetail" }, "type": "array", "description": "List of top NasTrials in the requested page." }, "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results. Pass to ListNasTrialDetailsRequest.page_token to obtain that page." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ListNasTrialDetailsResponse", "description": "Response message for JobService.ListNasTrialDetails" }, "GoogleCloudAiplatformV1beta1SchemaImageClassificationAnnotation": { "type": "object", "properties": { "annotationSpecId": { "description": "The resource Id of the AnnotationSpec that this Annotation pertains to.", "type": "string" }, "displayName": { "type": "string", "description": "The display name of the AnnotationSpec that this Annotation pertains to." } }, "id": "GoogleCloudAiplatformV1beta1SchemaImageClassificationAnnotation", "description": "Annotation details specific to image classification." }, "GoogleCloudAiplatformV1beta1TuningJob": { "type": "object", "id": "GoogleCloudAiplatformV1beta1TuningJob", "properties": { "state": { "readOnly": true, "description": "Output only. The detailed state of the job.", "enum": [ "JOB_STATE_UNSPECIFIED", "JOB_STATE_QUEUED", "JOB_STATE_PENDING", "JOB_STATE_RUNNING", "JOB_STATE_SUCCEEDED", "JOB_STATE_FAILED", "JOB_STATE_CANCELLING", "JOB_STATE_CANCELLED", "JOB_STATE_PAUSED", "JOB_STATE_EXPIRED", "JOB_STATE_UPDATING", "JOB_STATE_PARTIALLY_SUCCEEDED" ], "type": "string", "enumDescriptions": [ "The job state is unspecified.", "The job has been just created or resumed and processing has not yet begun.", "The service is preparing to run the job.", "The job is in progress.", "The job completed successfully.", "The job failed.", "The job is being cancelled. From this state the job may only go to either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.", "The job has been cancelled.", "The job has been stopped, and can be resumed.", "The job has expired.", "The job is being updated. Only jobs in the `RUNNING` state can be updated. After updating, the job goes back to the `RUNNING` state.", "The job is partially succeeded, some results may be missing due to errors." ] }, "encryptionSpec": { "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec", "description": "Customer-managed encryption key options for a TuningJob. If this is set, then all resources created by the TuningJob will be encrypted with the provided encryption key." }, "labels": { "description": "Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.", "additionalProperties": { "type": "string" }, "type": "object" }, "satisfiesPzs": { "type": "boolean", "description": "Output only. Reserved for future use.", "readOnly": true }, "preferenceOptimizationSpec": { "$ref": "GoogleCloudAiplatformV1beta1PreferenceOptimizationSpec", "description": "Tuning Spec for Preference Optimization." }, "preTunedModel": { "description": "The pre-tuned model for continuous tuning.", "$ref": "GoogleCloudAiplatformV1beta1PreTunedModel" }, "tuningJobState": { "enumDescriptions": [ "Default tuning job state.", "Tuning job is waiting for job quota.", "Tuning job is validating the dataset.", "Tuning job is waiting for hardware capacity.", "Tuning job is running.", "Tuning job is doing some post processing steps." ], "readOnly": true, "enum": [ "TUNING_JOB_STATE_UNSPECIFIED", "TUNING_JOB_STATE_WAITING_FOR_QUOTA", "TUNING_JOB_STATE_PROCESSING_DATASET", "TUNING_JOB_STATE_WAITING_FOR_CAPACITY", "TUNING_JOB_STATE_TUNING", "TUNING_JOB_STATE_POST_PROCESSING" ], "description": "Output only. The detail state of the tuning job (while the overall `JobState` is running).", "type": "string" }, "tuningDataStats": { "description": "Output only. The tuning data statistics associated with this TuningJob.", "$ref": "GoogleCloudAiplatformV1beta1TuningDataStats", "readOnly": true }, "serviceAccount": { "description": "The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.", "type": "string" }, "reinforcementTuningSpec": { "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningSpec", "description": "Tuning Spec for Reinforcement Tuning." }, "startTime": { "format": "google-datetime", "description": "Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.", "type": "string", "readOnly": true }, "veoLoraTuningSpec": { "description": "Tuning Spec for Veo LoRA Tuning.", "$ref": "GoogleCloudAiplatformV1beta1VeoLoraTuningSpec" }, "name": { "description": "Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", "readOnly": true, "type": "string" }, "updateTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. Time when the TuningJob was most recently updated." }, "evaluateDatasetRuns": { "readOnly": true, "description": "Output only. Evaluation runs for the Tuning Job.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1EvaluateDatasetRun" } }, "customBaseModel": { "type": "string", "description": "Optional. The user-provided path to custom model weights. Set this field to tune a custom model. The path must be a Cloud Storage directory that contains the model weights in .safetensors format along with associated model metadata files. If this field is set, the base_model field must still be set to indicate which base model the custom model is derived from. This feature is only available for open source models." }, "error": { "readOnly": true, "$ref": "GoogleRpcStatus", "description": "Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`." }, "baseModel": { "type": "string", "description": "The base model that is being tuned. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models)." }, "tunedModelDisplayName": { "type": "string", "description": "Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version." }, "veoTuningSpec": { "$ref": "GoogleCloudAiplatformV1beta1VeoTuningSpec", "description": "Tuning Spec for Veo Tuning." }, "fullFineTuningSpec": { "description": "Tuning Spec for Full Fine Tuning.", "$ref": "GoogleCloudAiplatformV1beta1FullFineTuningSpec" }, "createTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. Time when the TuningJob was created." }, "endTime": { "description": "Output only. Time when the TuningJob entered any of the following JobStates: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`.", "type": "string", "format": "google-datetime", "readOnly": true }, "pipelineJob": { "description": "Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`.", "type": "string", "deprecated": true, "readOnly": true }, "partnerModelTuningSpec": { "description": "Tuning Spec for open sourced and third party Partner models.", "$ref": "GoogleCloudAiplatformV1beta1PartnerModelTuningSpec" }, "tunedModel": { "description": "Output only. The tuned model resources associated with this TuningJob.", "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1TunedModel" }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "type": "boolean", "readOnly": true }, "tuningJobMetadata": { "$ref": "GoogleCloudAiplatformV1beta1TuningJobMetadata", "description": "Output only. Tuning Job metadata.", "readOnly": true }, "supervisedTuningSpec": { "description": "Tuning Spec for Supervised Fine Tuning.", "$ref": "GoogleCloudAiplatformV1beta1SupervisedTuningSpec" }, "distillationSpec": { "description": "Tuning Spec for Distillation.", "$ref": "GoogleCloudAiplatformV1beta1DistillationSpec" }, "outputUri": { "type": "string", "description": "Optional. Cloud Storage path to the directory where tuning job outputs are written to. This field is only available and required for open source models." }, "experiment": { "readOnly": true, "type": "string", "description": "Output only. The Experiment associated with this TuningJob." }, "description": { "type": "string", "description": "Optional. The description of the TuningJob." } }, "description": "Represents a TuningJob that runs with Google owned models." }, "GoogleCloudAiplatformV1beta1ListNotebookRuntimeTemplatesResponse": { "id": "GoogleCloudAiplatformV1beta1ListNotebookRuntimeTemplatesResponse", "description": "Response message for NotebookService.ListNotebookRuntimeTemplates.", "type": "object", "properties": { "notebookRuntimeTemplates": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate" }, "description": "List of NotebookRuntimeTemplates in the requested page." }, "nextPageToken": { "type": "string", "description": "A token to retrieve next page of results. Pass to ListNotebookRuntimeTemplatesRequest.page_token to obtain that page." } } }, "GoogleCloudAiplatformV1beta1LossAnalysisResult": { "id": "GoogleCloudAiplatformV1beta1LossAnalysisResult", "description": "The top-level result for loss analysis, stored within an EvalSet.", "properties": { "config": { "$ref": "GoogleCloudAiplatformV1beta1LossAnalysisConfig", "description": "The configuration used to generate this analysis." }, "analysisTime": { "description": "The timestamp when this analysis was performed.", "format": "google-datetime", "type": "string" }, "clusters": { "description": "The list of identified loss clusters.", "items": { "$ref": "GoogleCloudAiplatformV1beta1LossCluster" }, "type": "array" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ExplanationMetadataInputMetadataFeatureValueDomain": { "properties": { "minValue": { "type": "number", "description": "The minimum permissible value for this feature.", "format": "float" }, "maxValue": { "description": "The maximum permissible value for this feature.", "type": "number", "format": "float" }, "originalStddev": { "type": "number", "format": "float", "description": "If this input feature has been normalized to a standard deviation of 1.0, the original_stddev specifies the standard deviation of the domain prior to normalization." }, "originalMean": { "type": "number", "format": "float", "description": "If this input feature has been normalized to a mean value of 0, the original_mean specifies the mean value of the domain prior to normalization." } }, "description": "Domain details of the input feature value. Provides numeric information about the feature, such as its range (min, max). If the feature has been pre-processed, for example with z-scoring, then it provides information about how to recover the original feature. For example, if the input feature is an image and it has been pre-processed to obtain 0-mean and stddev = 1 values, then original_mean, and original_stddev refer to the mean and stddev of the original feature (e.g. image tensor) from which input feature (with mean = 0 and stddev = 1) was obtained.", "type": "object", "id": "GoogleCloudAiplatformV1beta1ExplanationMetadataInputMetadataFeatureValueDomain" }, "GoogleCloudAiplatformV1beta1MeasurementMetric": { "id": "GoogleCloudAiplatformV1beta1MeasurementMetric", "type": "object", "description": "A message representing a metric in the measurement.", "properties": { "metricId": { "description": "Output only. The ID of the Metric. The Metric should be defined in StudySpec's Metrics.", "readOnly": true, "type": "string" }, "value": { "type": "number", "description": "Output only. The value for this metric.", "readOnly": true, "format": "double" } } }, "GenaiVertexV1beta1CodeMenderAgentConfigFindRequest": { "properties": { "findingId": { "type": "string", "description": "The identifier of a specific finding to verify. This is primarily used in VERIFY mode to focus the agent's execution-based validation on a single vulnerability." }, "mode": { "enumDescriptions": [ "Default value. This value is unused.", "Fast scan using only the initial classifier.", "Performs classification followed by detailed investigation." ], "type": "string", "enum": [ "MODE_UNSPECIFIED", "MODE_SCAN", "MODE_VERIFY" ], "description": "The mode of the find session." }, "sourceFiles": { "items": { "$ref": "GenaiVertexV1beta1CodeMenderAgentConfigFileContent" }, "description": "A list of source files to provide as context for the scan.", "type": "array" }, "description": { "type": "string", "description": "Additional context or custom instructions provided by the user to guide the vulnerability analysis." } }, "id": "GenaiVertexV1beta1CodeMenderAgentConfigFindRequest", "description": "Request parameters specific to FIND sessions, used for discovering vulnerabilities in a codebase.", "type": "object" }, "GoogleCloudAiplatformV1beta1FeatureSelectionConfigFeatureConfig": { "properties": { "driftThreshold": { "description": "Optional. Drift threshold. If calculated difference with baseline data larger than threshold, it will be considered as the feature has drift. If not present, the threshold will be default to 0.3. Must be in range [0, 1).", "format": "double", "type": "number" }, "featureId": { "type": "string", "description": "Required. The ID of the feature resource. Final component of the Feature's resource name." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1FeatureSelectionConfigFeatureConfig", "description": "Feature configuration." }, "GenaiVertexV1beta1ProcessingResultDelta": { "type": "object", "description": "Streaming delta for the result of a server-initiated media processing step.", "properties": {}, "id": "GenaiVertexV1beta1ProcessingResultDelta" }, "CloudAiLargeModelsVisionGenerateVideoRequestVideo": { "type": "object", "properties": { "blobId": { "type": "string", "description": "Blob ID of the video. This is used for storing large videos in the request." }, "gcsUri": { "type": "string" }, "bytesBase64Encoded": { "type": "string", "description": "Base64 encoded bytes string representing the video." }, "mimeType": { "description": "The MIME type of the content of the video. Only the video in the below listed MIME types are supported. - video/mp4", "type": "string" } }, "id": "CloudAiLargeModelsVisionGenerateVideoRequestVideo" }, "CloudAiLargeModelsVisionMedia": { "type": "object", "properties": { "image": { "$ref": "CloudAiLargeModelsVisionImage", "description": "Image." }, "video": { "description": "Video", "$ref": "CloudAiLargeModelsVisionVideo" } }, "id": "CloudAiLargeModelsVisionMedia", "description": "Media." }, "GoogleCloudAiplatformV1beta1SchemaPromptSpecReferenceSentencePairList": { "description": "A list of reference sentence pairs.", "properties": { "referenceSentencePairs": { "description": "Reference sentence pairs.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaPromptSpecReferenceSentencePair" } } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaPromptSpecReferenceSentencePairList" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation": { "description": "Training pipeline will perform following transformation functions. * The categorical string as is--no change to case, punctuation, spelling, tense, and so on. * Convert the category name to a dictionary lookup index and generate an embedding for each index. * Categories that appear less than 5 times in the training dataset are treated as the \"unknown\" category. The \"unknown\" category gets its own special lookup index and resulting embedding.", "properties": { "columnName": { "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation" }, "GoogleCloudAiplatformV1beta1MutateDeployedModelOperationMetadata": { "id": "GoogleCloudAiplatformV1beta1MutateDeployedModelOperationMetadata", "properties": { "genericMetadata": { "description": "The operation generic information.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "type": "object", "description": "Runtime operation information for EndpointService.MutateDeployedModel." }, "GoogleCloudAiplatformV1beta1ListSemanticGovernancePoliciesResponse": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ListSemanticGovernancePoliciesResponse", "properties": { "semanticGovernancePolicies": { "items": { "$ref": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicy" }, "description": "The list of SemanticGovernancePolicies.", "type": "array" }, "nextPageToken": { "description": "A token to retrieve the next page of results. Pass to ListSemanticGovernancePoliciesRequest.page_token to obtain that page.", "type": "string" } }, "description": "Response message for SemanticGovernancePolicyService.ListSemanticGovernancePolicies." }, "GoogleCloudAiplatformV1beta1Feature": { "properties": { "disableMonitoring": { "type": "boolean", "description": "Optional. Only applicable for Vertex AI Feature Store (Legacy). If not set, use the monitoring_config defined for the EntityType this Feature belongs to. Only Features with type (Feature.ValueType) BOOL, STRING, DOUBLE or INT64 can enable monitoring. If set to true, all types of data monitoring are disabled despite the config on EntityType." }, "pointOfContact": { "description": "Entity responsible for maintaining this feature. Can be comma separated list of email addresses or URIs.", "type": "string" }, "updateTime": { "type": "string", "readOnly": true, "description": "Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was most recently updated.", "format": "google-datetime" }, "monitoringConfig": { "description": "Optional. Only applicable for Vertex AI Feature Store (Legacy). Deprecated: The custom monitoring configuration for this Feature, if not set, use the monitoring_config defined for the EntityType this Feature belongs to. Only Features with type (Feature.ValueType) BOOL, STRING, DOUBLE or INT64 can enable monitoring. If this is populated with FeaturestoreMonitoringConfig.disabled = true, snapshot analysis monitoring is disabled; if FeaturestoreMonitoringConfig.monitoring_interval specified, snapshot analysis monitoring is enabled. Otherwise, snapshot analysis monitoring config is same as the EntityType's this Feature belongs to.", "deprecated": true, "$ref": "GoogleCloudAiplatformV1beta1FeaturestoreMonitoringConfig" }, "name": { "description": "Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.", "type": "string" }, "description": { "description": "Description of the Feature.", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was created.", "readOnly": true, "type": "string" }, "monitoringStatsAnomalies": { "readOnly": true, "items": { "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitoringStatsAnomaly" }, "description": "Output only. Only applicable for Vertex AI Feature Store (Legacy). The list of historical stats and anomalies with specified objectives.", "type": "array" }, "monitoringStats": { "readOnly": true, "type": "array", "description": "Output only. Only applicable for Vertex AI Feature Store (Legacy). A list of historical SnapshotAnalysis stats requested by user, sorted by FeatureStatsAnomaly.start_time descending.", "items": { "$ref": "GoogleCloudAiplatformV1beta1FeatureStatsAnomaly" } }, "featureStatsAndAnomaly": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1FeatureStatsAndAnomaly" }, "readOnly": true, "description": "Output only. Only applicable for Vertex AI Feature Store. The list of historical stats and anomalies." }, "versionColumnName": { "type": "string", "description": "Only applicable for Vertex AI Feature Store. The name of the BigQuery Table/View column hosting data for this version. If no value is provided, will use feature_id." }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. The labels with user-defined metadata to organize your Features. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one Feature (System labels are excluded).\" System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable." }, "valueType": { "type": "string", "enumDescriptions": [ "The value type is unspecified.", "Used for Feature that is a boolean.", "Used for Feature that is a list of boolean.", "Used for Feature that is double.", "Used for Feature that is a list of double.", "Used for Feature that is INT64.", "Used for Feature that is a list of INT64.", "Used for Feature that is string.", "Used for Feature that is a list of String.", "Used for Feature that is bytes.", "Used for Feature that is struct." ], "description": "Immutable. Only applicable for Vertex AI Feature Store (Legacy). Type of Feature value.", "enum": [ "VALUE_TYPE_UNSPECIFIED", "BOOL", "BOOL_ARRAY", "DOUBLE", "DOUBLE_ARRAY", "INT64", "INT64_ARRAY", "STRING", "STRING_ARRAY", "BYTES", "STRUCT" ] }, "etag": { "description": "Used to perform a consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1Feature", "description": "Feature Metadata information. For example, color is a feature that describes an apple." }, "GoogleCloudAiplatformV1beta1ListModelEvaluationsResponse": { "type": "object", "properties": { "modelEvaluations": { "items": { "$ref": "GoogleCloudAiplatformV1beta1ModelEvaluation" }, "description": "List of ModelEvaluations in the requested page.", "type": "array" }, "nextPageToken": { "description": "A token to retrieve next page of results. Pass to ListModelEvaluationsRequest.page_token to obtain that page.", "type": "string" } }, "description": "Response message for ModelService.ListModelEvaluations.", "id": "GoogleCloudAiplatformV1beta1ListModelEvaluationsResponse" }, "GoogleCloudAiplatformV1beta1ReadTensorboardSizeResponse": { "id": "GoogleCloudAiplatformV1beta1ReadTensorboardSizeResponse", "type": "object", "properties": { "storageSizeByte": { "description": "Payload storage size for the TensorBoard", "format": "int64", "type": "string" } }, "description": "Response message for TensorboardService.ReadTensorboardSize." }, "GoogleCloudAiplatformV1beta1SecretRef": { "type": "object", "description": "Reference to a secret stored in the Cloud Secret Manager that will provide the value for this environment variable.", "id": "GoogleCloudAiplatformV1beta1SecretRef", "properties": { "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" }, "secret": { "description": "Required. The name of the secret in Cloud Secret Manager. Format: {secret_name}.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualitySpec": { "description": "Spec for pairwise question answering quality score metric.", "id": "GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualitySpec", "type": "object", "properties": { "version": { "format": "int32", "description": "Optional. Which version to use for evaluation.", "type": "integer" }, "useReference": { "type": "boolean", "description": "Optional. Whether to use instance.reference to compute question answering quality." } } }, "GoogleCloudAiplatformV1beta1EmbedContentRequestEmbedContentConfig": { "description": "Configurations for the EmbedContent API.", "properties": { "autoTruncate": { "description": "Optional. Whether to silently truncate the input content if it's longer than the maximum sequence length. Only applicable to text-only embedding models.", "type": "boolean" }, "taskType": { "enum": [ "UNSPECIFIED", "RETRIEVAL_QUERY", "RETRIEVAL_DOCUMENT", "SEMANTIC_SIMILARITY", "CLASSIFICATION", "CLUSTERING", "QUESTION_ANSWERING", "FACT_VERIFICATION", "CODE_RETRIEVAL_QUERY" ], "type": "string", "description": "Optional. The task type of the embedding. Only applicable to text-only embedding models.", "enumDescriptions": [ "Unset value, which will default to one of the other enum values.", "Specifies the given text is a query in a search/retrieval setting.", "Specifies the given text is a document from the corpus being searched.", "Specifies the given text will be used for STS.", "Specifies that the given text will be classified.", "Specifies that the embeddings will be used for clustering.", "Specifies that the embeddings will be used for question answering.", "Specifies that the embeddings will be used for fact verification.", "Specifies that the embeddings will be used for code retrieval." ] }, "outputDimensionality": { "description": "Optional. Reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end.", "format": "int32", "type": "integer" }, "audioTrackExtraction": { "type": "boolean", "description": "Optional. Whether to extract audio from video content." }, "documentOcr": { "type": "boolean", "description": "Optional. Whether to enable OCR for document content." }, "title": { "description": "Optional. The title for the text. Only applicable to text-only embedding models.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1EmbedContentRequestEmbedContentConfig", "type": "object" }, "GenaiVertexV1beta1ServerToolCallDelta": { "id": "GenaiVertexV1beta1ServerToolCallDelta", "properties": { "signature": { "format": "byte", "type": "string", "description": "A signature hash for backend validation." }, "googleMapsCall": { "$ref": "GenaiVertexV1beta1GoogleMapsCallDelta" }, "processingCall": { "$ref": "GenaiVertexV1beta1ProcessingCallDelta" }, "codeExecutionCall": { "$ref": "GenaiVertexV1beta1CodeExecutionCallDelta" }, "fileSearchCall": { "$ref": "GenaiVertexV1beta1FileSearchCallDelta" }, "retrievalCall": { "$ref": "GenaiVertexV1beta1RetrievalCallDelta" }, "urlContextCall": { "$ref": "GenaiVertexV1beta1UrlContextCallDelta" }, "mcpServerToolCall": { "$ref": "GenaiVertexV1beta1McpServerToolCallDelta" }, "googleSearchCall": { "$ref": "GenaiVertexV1beta1GoogleSearchCallDelta" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ModelBaseModelSource": { "description": "User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models.", "properties": { "genieSource": { "$ref": "GoogleCloudAiplatformV1beta1GenieSource", "description": "Information about the base model of Genie models." }, "modelGardenSource": { "$ref": "GoogleCloudAiplatformV1beta1ModelGardenSource", "description": "Source information of Model Garden models." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ModelBaseModelSource" }, "GoogleCloudAiplatformV1beta1SandboxEnvironmentConnectionInfo": { "id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentConnectionInfo", "properties": { "loadBalancerHostname": { "readOnly": true, "type": "string", "description": "Output only. The hostname of the load balancer." }, "routingToken": { "type": "string", "description": "Output only. The routing token for the SandboxEnvironment.", "readOnly": true }, "sandboxInternalIp": { "type": "string", "description": "Output only. The internal IP address of the SandboxEnvironment.", "readOnly": true }, "loadBalancerIp": { "readOnly": true, "description": "Output only. The IP address of the load balancer.", "type": "string" }, "serviceAttachment": { "readOnly": true, "type": "string", "description": "Output only. The name of the PSC-E service attachment created for private ingress to this SandboxEnvironment. Only populated when the template enables private ingress (see SandboxEnvironmentTemplate.ingress_control_config). VPC-SC customers use this to create a PSC endpoint in their VPC." } }, "type": "object", "description": "The connection information of the SandboxEnvironment." }, "GoogleCloudAiplatformV1beta1Session": { "description": "A session contains a set of actions between users and Vertex agents.", "id": "GoogleCloudAiplatformV1beta1Session", "properties": { "labels": { "type": "object", "description": "The labels with user-defined metadata to organize your Sessions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.", "additionalProperties": { "type": "string" } }, "displayName": { "description": "Optional. The display name of the session.", "type": "string" }, "createTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp when the session was created.", "type": "string" }, "userId": { "type": "string", "description": "Required. Immutable. String id provided by the user" }, "sessionState": { "description": "Optional. Session specific memory which stores key conversation points.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "expireTime": { "description": "Optional. Timestamp of when this session is considered expired. This is *always* provided on output, regardless of what was sent on input. The minimum value is 24 hours from the time of creation.", "type": "string", "format": "google-datetime" }, "name": { "description": "Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.", "type": "string" }, "updateTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. Timestamp when the session was updated." }, "ttl": { "format": "google-duration", "type": "string", "description": "Optional. Input only. The TTL for this session. The minimum value is 24 hours." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ToolParameterKVMatchResults": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ToolParameterKVMatchResults", "description": "Results for tool parameter key value match metric.", "properties": { "toolParameterKvMatchMetricValues": { "description": "Output only. Tool parameter key value match metric values.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ToolParameterKVMatchMetricValue" }, "type": "array", "readOnly": true } } }, "GenaiVertexV1beta1ResponseFormat": { "properties": { "structValue": { "description": "Multi-discriminator values is already enabled in GAOS", "$ref": "GenaiVertexV1beta1Struct" }, "text": { "$ref": "GenaiVertexV1beta1TextResponseFormat" }, "video": { "$ref": "GenaiVertexV1beta1VideoResponseFormat" }, "audio": { "$ref": "GenaiVertexV1beta1AudioResponseFormat" }, "image": { "$ref": "GenaiVertexV1beta1ImageResponseFormat" } }, "type": "object", "id": "GenaiVertexV1beta1ResponseFormat" }, "GoogleCloudAiplatformV1beta1ResponseFormat": { "properties": { "audio": { "description": "Audio output format.", "$ref": "GoogleCloudAiplatformV1beta1AudioResponseFormat" }, "image": { "$ref": "GoogleCloudAiplatformV1beta1ImageResponseFormat", "description": "Image output format." }, "text": { "$ref": "GoogleCloudAiplatformV1beta1TextResponseFormat", "description": "Text output format." }, "video": { "description": "Video output format.", "$ref": "GoogleCloudAiplatformV1beta1VideoResponseFormat" } }, "description": "Configuration for the model to configure output formatting and delivery.", "id": "GoogleCloudAiplatformV1beta1ResponseFormat", "type": "object" }, "GoogleCloudAiplatformV1beta1MigratableResource": { "description": "Represents one resource that exists in automl.googleapis.com, datalabeling.googleapis.com or ml.googleapis.com.", "properties": { "lastUpdateTime": { "format": "google-datetime", "type": "string", "description": "Output only. Timestamp when this MigratableResource was last updated.", "readOnly": true }, "mlEngineModelVersion": { "description": "Output only. Represents one Version in ml.googleapis.com.", "$ref": "GoogleCloudAiplatformV1beta1MigratableResourceMlEngineModelVersion", "readOnly": true }, "lastMigrateTime": { "description": "Output only. Timestamp when the last migration attempt on this MigratableResource started. Will not be set if there's no migration attempt on this MigratableResource.", "format": "google-datetime", "type": "string", "readOnly": true }, "automlDataset": { "$ref": "GoogleCloudAiplatformV1beta1MigratableResourceAutomlDataset", "description": "Output only. Represents one Dataset in automl.googleapis.com.", "readOnly": true }, "automlModel": { "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1MigratableResourceAutomlModel", "description": "Output only. Represents one Model in automl.googleapis.com." }, "dataLabelingDataset": { "deprecated": true, "$ref": "GoogleCloudAiplatformV1beta1MigratableResourceDataLabelingDataset", "readOnly": true, "description": "Output only. Deprecated: Data Labeling Dataset migration is no longer supported. Represents one Dataset in datalabeling.googleapis.com." } }, "id": "GoogleCloudAiplatformV1beta1MigratableResource", "type": "object" }, "GoogleCloudAiplatformV1beta1LargeModelReference": { "type": "object", "description": "Contains information about the Large Model.", "id": "GoogleCloudAiplatformV1beta1LargeModelReference", "properties": { "name": { "type": "string", "description": "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." } } }, "GoogleCloudAiplatformV1beta1ServiceAccountSpec": { "description": "Configuration for the use of custom service account to run the workloads.", "id": "GoogleCloudAiplatformV1beta1ServiceAccountSpec", "properties": { "serviceAccount": { "description": "Optional. Required when all below conditions are met * `enable_custom_service_account` is true; * any runtime is specified via `ResourceRuntimeSpec` on creation time, for example, Ray The users must have `iam.serviceAccounts.actAs` permission on this service account and then the specified runtime containers will run as it. Do not set this field if you want to submit jobs using custom service account to this PersistentResource after creation, but only specify the `service_account` inside the job.", "type": "string" }, "enableCustomServiceAccount": { "type": "boolean", "description": "Required. If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1EvaluationInstanceInteractionsDataSource": { "properties": { "geminiAgentConfig": { "description": "Optional. Gemini Agent (Vertex AI Agent resource).", "$ref": "GoogleCloudAiplatformV1beta1GeminiAgentConfig" }, "interaction": { "type": "string", "description": "Required. The interaction to evaluate. Format: `projects/{project}/locations/{location}/interactions/{interaction}`." } }, "description": "Source for populating `AgentData` from an Interactions API interaction.", "type": "object", "id": "GoogleCloudAiplatformV1beta1EvaluationInstanceInteractionsDataSource" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingMetadata": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingMetadata", "description": "Model metadata specific to TFT Forecasting.", "properties": { "evaluatedDataItemsBigqueryUri": { "description": "BigQuery destination uri for exported evaluated examples.", "type": "string" }, "trainCostMilliNodeHours": { "type": "string", "format": "int64", "description": "Output only. The actual training cost of the model, expressed in milli node hours, i.e. 1,000 value in this field means 1 node hour. Guaranteed to not exceed the train budget." } } }, "GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricBasedMetricSpec": { "type": "object", "description": "Specification for a metric that is based on rubrics.", "id": "GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricBasedMetricSpec", "properties": { "rubricGroupKey": { "type": "string", "description": "Use a pre-defined group of rubrics associated with the input content. This refers to a key in the `rubric_groups` map of `RubricEnhancedContents`." }, "rubricGenerationSpec": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricGenerationSpec", "description": "Dynamically generate rubrics for evaluation using this specification." }, "metricPromptTemplate": { "description": "Optional. Template for the prompt used by the judge model to evaluate against rubrics.", "type": "string" }, "judgeAutoraterConfig": { "description": "Optional. Optional configuration for the judge LLM (Autorater). The definition of AutoraterConfig needs to be provided.", "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigAutoraterConfig" }, "inlineRubrics": { "description": "Use rubrics provided directly in the spec.", "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricBasedMetricSpecRepeatedRubrics" } } }, "GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfig": { "description": "Composite reward function configuration for reinforcement tuning.", "id": "GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfig", "properties": { "weightedRewardConfigs": { "description": "List of reward function configurations with weights.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfigWeightedRewardConfig" } } }, "type": "object" }, "GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsFilter": { "id": "GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsFilter", "properties": { "tabularStatsFilter": { "$ref": "GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsFilterTabularStatsFilter", "description": "Tabular statistics filter." } }, "description": "Filter for searching ModelMonitoringStats.", "type": "object" }, "GenaiVertexV1beta1FunctionResultStep": { "properties": { "name": { "description": "The name of the tool that was called.", "type": "string" }, "isError": { "description": "Whether the tool call resulted in an error.", "type": "boolean" }, "result": { "description": "Required. The result of the tool call.", "$ref": "GenaiVertexV1beta1Value" } }, "description": "Result of a function tool call.", "type": "object", "id": "GenaiVertexV1beta1FunctionResultStep" }, "GoogleCloudAiplatformV1beta1Neighbor": { "description": "Neighbors for example-based explanations.", "type": "object", "id": "GoogleCloudAiplatformV1beta1Neighbor", "properties": { "neighborId": { "type": "string", "description": "Output only. The neighbor id.", "readOnly": true }, "neighborDistance": { "description": "Output only. The neighbor distance.", "readOnly": true, "format": "double", "type": "number" } } }, "GoogleCloudAiplatformV1beta1PublisherModelResourceReference": { "id": "GoogleCloudAiplatformV1beta1PublisherModelResourceReference", "type": "object", "properties": { "useCase": { "description": "Use case (CUJ) of the resource.", "deprecated": true, "type": "string" }, "description": { "deprecated": true, "description": "Description of the resource.", "type": "string" }, "resourceName": { "type": "string", "description": "The resource name of the Google Cloud resource." }, "uri": { "description": "The URI of the resource.", "type": "string" } }, "description": "Reference to a resource." }, "GoogleCloudAiplatformV1beta1StudyTimeConstraint": { "properties": { "maxDuration": { "description": "Counts the wallclock time passed since the creation of this Study.", "type": "string", "format": "google-duration" }, "endTime": { "description": "Compares the wallclock time to this time. Must use UTC timezone.", "format": "google-datetime", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1StudyTimeConstraint", "description": "Time-based Constraint for Study", "type": "object" }, "GoogleCloudAiplatformV1beta1CometInstance": { "type": "object", "id": "GoogleCloudAiplatformV1beta1CometInstance", "description": "Spec for Comet instance - The fields used for evaluation are dependent on the comet version.", "properties": { "prediction": { "type": "string", "description": "Required. Output of the evaluated model." }, "source": { "description": "Optional. Source text in original language.", "type": "string" }, "reference": { "type": "string", "description": "Optional. Ground truth used to compare against the prediction." } } }, "GoogleCloudAiplatformV1beta1CreateDeploymentResourcePoolRequest": { "id": "GoogleCloudAiplatformV1beta1CreateDeploymentResourcePoolRequest", "type": "object", "properties": { "deploymentResourcePoolId": { "description": "Required. The ID to use for the DeploymentResourcePool, which will become the final component of the DeploymentResourcePool's resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.", "type": "string" }, "deploymentResourcePool": { "$ref": "GoogleCloudAiplatformV1beta1DeploymentResourcePool", "description": "Required. The DeploymentResourcePool to create." } }, "description": "Request message for CreateDeploymentResourcePool method." }, "GoogleCloudAiplatformV1beta1ThresholdConfig": { "type": "object", "description": "The config for feature monitoring threshold.", "properties": { "value": { "format": "double", "type": "number", "description": "Specify a threshold value that can trigger the alert. If this threshold config is for feature distribution distance: 1. For categorical feature, the distribution distance is calculated by L-inifinity norm. 2. For numerical feature, the distribution distance is calculated by Jensen–Shannon divergence. Each feature must have a non-zero threshold if they need to be monitored. Otherwise no alert will be triggered for that feature." } }, "id": "GoogleCloudAiplatformV1beta1ThresholdConfig" }, "GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigArtifactList": { "description": "A list of artifact metadata.", "type": "object", "properties": { "artifacts": { "items": { "$ref": "GoogleCloudAiplatformV1beta1RuntimeArtifact" }, "description": "Optional. A list of artifact metadata.", "type": "array" } }, "id": "GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigArtifactList" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextExtraction": { "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextExtraction", "type": "object", "description": "A TrainingJob that trains and uploads an AutoML Text Extraction Model.", "properties": { "inputs": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs", "description": "The input parameters of this TrainingJob." } } }, "GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentResponse": { "type": "object", "description": "Response message for SandboxEnvironmentExecutionService.Execute.", "properties": { "outputs": { "type": "array", "description": "The outputs from the sandbox environment.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Chunk" } } }, "id": "GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentResponse" }, "GoogleCloudAiplatformV1beta1PurgeContextsRequest": { "type": "object", "id": "GoogleCloudAiplatformV1beta1PurgeContextsRequest", "properties": { "filter": { "description": "Required. A required filter matching the Contexts to be purged. E.g., `update_time \u003c= 2020-11-19T11:30:00-04:00`.", "type": "string" }, "force": { "type": "boolean", "description": "Optional. Flag to indicate to actually perform the purge. If `force` is set to false, the method will return a sample of Context names that would be deleted." } }, "description": "Request message for MetadataService.PurgeContexts." }, "GoogleCloudAiplatformV1beta1ModelMonitoringNotificationSpecEmailConfig": { "properties": { "userEmails": { "type": "array", "items": { "type": "string" }, "description": "The email addresses to send the alerts." } }, "id": "GoogleCloudAiplatformV1beta1ModelMonitoringNotificationSpecEmailConfig", "type": "object", "description": "The config for email alerts." }, "GoogleCloudAiplatformV1beta1DedicatedResourcesScaleToZeroSpec": { "properties": { "minScaleupPeriod": { "format": "google-duration", "description": "Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)", "type": "string" }, "idleScaledownPeriod": { "type": "string", "description": "Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)", "format": "google-duration" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1DedicatedResourcesScaleToZeroSpec", "description": "Specification for scale-to-zero feature." }, "GenaiVertexV1beta1ThoughtStep": { "description": "A thought step.", "properties": { "summary": { "description": "A summary of the thought.", "type": "array", "items": { "$ref": "GenaiVertexV1beta1Content" } }, "signature": { "type": "string", "description": "A signature hash for backend validation.", "format": "byte" } }, "type": "object", "id": "GenaiVertexV1beta1ThoughtStep" }, "GoogleCloudAiplatformV1beta1BatchCreateFeaturesOperationMetadata": { "properties": { "genericMetadata": { "description": "Operation metadata for Feature.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "type": "object", "description": "Details of operations that perform batch create Features.", "id": "GoogleCloudAiplatformV1beta1BatchCreateFeaturesOperationMetadata" }, "GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigDefaultRuntime": { "description": "The default runtime for the PipelineJob.", "type": "object", "properties": { "persistentResourceRuntimeDetail": { "description": "Persistent resource based runtime detail.", "$ref": "GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigPersistentResourceRuntimeDetail" } }, "id": "GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigDefaultRuntime" }, "GoogleCloudAiplatformV1beta1ListA2aTaskEventsResponse": { "type": "object", "properties": { "events": { "items": { "$ref": "GoogleCloudAiplatformV1beta1A2aTaskEvent" }, "type": "array", "description": "List of A2aTaskEvents in the requested page. Populated only by the TaskStoreService." }, "taskEvents": { "type": "array", "description": "List of TaskEvents in the requested page. Populated only by the AgentEngineTaskStoreService.", "items": { "$ref": "GoogleCloudAiplatformV1beta1TaskEvent" } }, "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results." } }, "id": "GoogleCloudAiplatformV1beta1ListA2aTaskEventsResponse", "description": "Response message for ListA2aTaskEvents." }, "GoogleCloudAiplatformV1beta1PostStartupScriptConfig": { "properties": { "postStartupScriptUrl": { "type": "string", "description": "Optional. Post startup script url to download. Example: `gs://bucket/script.sh`" }, "postStartupScript": { "description": "Optional. Post startup script to run after runtime is started.", "type": "string" }, "postStartupScriptBehavior": { "type": "string", "description": "Optional. Post startup script behavior that defines download and execution behavior.", "enumDescriptions": [ "Unspecified post startup script behavior.", "Run post startup script after runtime is started.", "Run post startup script after runtime is stopped.", "Download and run post startup script every time runtime is started." ], "enum": [ "POST_STARTUP_SCRIPT_BEHAVIOR_UNSPECIFIED", "RUN_ONCE", "RUN_EVERY_START", "DOWNLOAD_AND_RUN_EVERY_START" ] } }, "description": "Post startup script config.", "id": "GoogleCloudAiplatformV1beta1PostStartupScriptConfig", "type": "object" }, "GenaiVertexV1beta1InteractionStartEvent": { "type": "object", "properties": { "interaction": { "$ref": "GenaiVertexV1beta1Interaction" } }, "deprecated": true, "id": "GenaiVertexV1beta1InteractionStartEvent" }, "GenaiVertexV1beta1ExaAISearchConfig": { "type": "object", "properties": { "apiKey": { "type": "string", "description": "Required. The API key for ExaAiSearch." }, "customConfig": { "description": "Optional. This field can be used to pass any parameter from the Exa.ai Search API.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" } }, "id": "GenaiVertexV1beta1ExaAISearchConfig", "description": "Used to specify configuration for ExaAISearch." }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation", "properties": { "columnName": { "type": "string" } }, "description": "Training pipeline will perform following transformation functions. * The categorical string as is--no change to case, punctuation, spelling, tense, and so on. * Convert the category name to a dictionary lookup index and generate an embedding for each index. * Categories that appear less than 5 times in the training dataset are treated as the \"unknown\" category. The \"unknown\" category gets its own special lookup index and resulting embedding." }, "GoogleCloudAiplatformV1beta1MemoryRevision": { "id": "GoogleCloudAiplatformV1beta1MemoryRevision", "properties": { "createTime": { "description": "Output only. Represents the timestamp when this Memory Revision was created.", "format": "google-datetime", "type": "string", "readOnly": true }, "structuredData": { "type": "object", "description": "Output only. Represents the structured value of the memory at the time of revision creation.", "readOnly": true, "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "extractedMemories": { "description": "Output only. Represents the extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1IntermediateExtractedMemory" }, "readOnly": true }, "fact": { "description": "Output only. Represents the fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation.", "readOnly": true, "type": "string" }, "expireTime": { "type": "string", "format": "google-datetime", "description": "Output only. Represents the timestamp of when this resource is considered expired.", "readOnly": true }, "name": { "type": "string", "description": "Identifier. Represents the resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}`" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Output only. Represents the labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`.", "readOnly": true }, "context": { "description": "Output only. Represents the context of the Memory Revision. The context may include context from both the historical revisions and the extracted content.", "type": "string", "readOnly": true } }, "type": "object", "description": "A revision of a Memory." }, "GoogleCloudAiplatformV1beta1DisableXmanagerOperationMetadata": { "type": "object", "description": "Metadata message for DisableXmanager RPC.", "id": "GoogleCloudAiplatformV1beta1DisableXmanagerOperationMetadata", "properties": { "genericMetadata": { "description": "Output only. Operation metadata for DisableXmanager.", "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" }, "progress": { "description": "Output only. Progress Message for DisableXmanager LRO", "type": "string", "readOnly": true } } }, "GoogleCloudAiplatformV1beta1RubricGroup": { "type": "object", "description": "A group of rubrics, used for grouping rubrics based on a metric or a version.", "id": "GoogleCloudAiplatformV1beta1RubricGroup", "properties": { "groupId": { "description": "Unique identifier for the group.", "type": "string" }, "rubrics": { "description": "Rubrics that are part of this group.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Rubric" } }, "displayName": { "description": "Human-readable name for the group. This should be unique within a given context if used for display or selection. Example: \"Instruction Following V1\", \"Content Quality - Summarization Task\".", "type": "string" } } }, "GoogleCloudAiplatformV1beta1ModelMonitoringOutputSpec": { "id": "GoogleCloudAiplatformV1beta1ModelMonitoringOutputSpec", "description": "Specification for the export destination of monitoring results, including metrics, logs, etc.", "type": "object", "properties": { "gcsBaseDirectory": { "description": "Google Cloud Storage base folder path for metrics, error logs, etc.", "$ref": "GoogleCloudAiplatformV1beta1GcsDestination" } } }, "GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadataRecordError": { "type": "object", "id": "GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadataRecordError", "properties": { "errorType": { "type": "string", "description": "The error type of this record.", "enum": [ "ERROR_TYPE_UNSPECIFIED", "EMPTY_LINE", "INVALID_JSON_SYNTAX", "INVALID_CSV_SYNTAX", "INVALID_AVRO_SYNTAX", "INVALID_EMBEDDING_ID", "EMBEDDING_SIZE_MISMATCH", "NAMESPACE_MISSING", "PARSING_ERROR", "DUPLICATE_NAMESPACE", "OP_IN_DATAPOINT", "MULTIPLE_VALUES", "INVALID_NUMERIC_VALUE", "INVALID_ENCODING", "INVALID_SPARSE_DIMENSIONS", "INVALID_TOKEN_VALUE", "INVALID_SPARSE_EMBEDDING", "INVALID_EMBEDDING", "INVALID_EMBEDDING_METADATA", "EMBEDDING_METADATA_EXCEEDS_SIZE_LIMIT", "DUPLICATE_ID" ], "enumDescriptions": [ "Default, shall not be used.", "The record is empty.", "Invalid json format.", "Invalid csv format.", "Invalid avro format.", "The embedding id is not valid.", "The size of the dense embedding vectors does not match with the specified dimension.", "The `namespace` field is missing.", "Generic catch-all error. Only used for validation failure where the root cause cannot be easily retrieved programmatically.", "There are multiple restricts with the same `namespace` value.", "Numeric restrict has operator specified in datapoint.", "Numeric restrict has multiple values specified.", "Numeric restrict has invalid numeric value specified.", "File is not in UTF_8 format.", "Error parsing sparse dimensions field.", "Token restrict value is invalid.", "Invalid sparse embedding.", "Invalid dense embedding.", "Invalid embedding metadata.", "Embedding metadata exceeds size limit.", "Multiple input records share the same datapoint id. The input conversion pipeline performs non-deterministic last-write-wins de-duplication and emits one error per duplicated id." ] }, "errorMessage": { "description": "A human-readable message that is shown to the user to help them fix the error. Note that this message may change from time to time, your code should check against error_type as the source of truth.", "type": "string" }, "embeddingId": { "description": "Empty if the embedding id is failed to parse.", "type": "string" }, "rawRecord": { "description": "The original content of this record.", "type": "string" }, "sourceGcsUri": { "type": "string", "description": "Cloud Storage URI pointing to the original file in user's bucket." } } }, "GoogleCloudAiplatformV1beta1FeaturestoreMonitoringConfigImportFeaturesAnalysis": { "id": "GoogleCloudAiplatformV1beta1FeaturestoreMonitoringConfigImportFeaturesAnalysis", "description": "Configuration of the Featurestore's ImportFeature Analysis Based Monitoring. This type of analysis generates statistics for values of each Feature imported by every ImportFeatureValues operation.", "properties": { "state": { "description": "Whether to enable / disable / inherite default hebavior for import features analysis.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "DEFAULT", "ENABLED", "DISABLED" ], "enumDescriptions": [ "Should not be used.", "The default behavior of whether to enable the monitoring. EntityType-level config: disabled. Feature-level config: inherited from the configuration of EntityType this Feature belongs to.", "Explicitly enables import features analysis. EntityType-level config: by default enables import features analysis for all Features under it. Feature-level config: enables import features analysis regardless of the EntityType-level config.", "Explicitly disables import features analysis. EntityType-level config: by default disables import features analysis for all Features under it. Feature-level config: disables import features analysis regardless of the EntityType-level config." ] }, "anomalyDetectionBaseline": { "enum": [ "BASELINE_UNSPECIFIED", "LATEST_STATS", "MOST_RECENT_SNAPSHOT_STATS", "PREVIOUS_IMPORT_FEATURES_STATS" ], "type": "string", "description": "The baseline used to do anomaly detection for the statistics generated by import features analysis.", "enumDescriptions": [ "Should not be used.", "Choose the later one statistics generated by either most recent snapshot analysis or previous import features analysis. If non of them exists, skip anomaly detection and only generate a statistics.", "Use the statistics generated by the most recent snapshot analysis if exists.", "Use the statistics generated by the previous import features analysis if exists." ] } }, "type": "object" }, "GoogleCloudAiplatformV1beta1StudySpecParameterSpecDoubleValueSpec": { "description": "Value specification for a parameter in `DOUBLE` type.", "id": "GoogleCloudAiplatformV1beta1StudySpecParameterSpecDoubleValueSpec", "properties": { "minValue": { "description": "Required. Inclusive minimum value of the parameter.", "format": "double", "type": "number" }, "maxValue": { "type": "number", "description": "Required. Inclusive maximum value of the parameter.", "format": "double" }, "defaultValue": { "type": "number", "format": "double", "description": "A default value for a `DOUBLE` parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ModelEvaluationSliceSliceSliceSpec": { "description": "Specification for how the data should be sliced.", "properties": { "configs": { "description": "Mapping configuration for this SliceSpec. The key is the name of the feature. By default, the key will be prefixed by \"instance\" as a dictionary prefix for Vertex Batch Predictions output format.", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1ModelEvaluationSliceSliceSliceSpecSliceConfig" }, "type": "object" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ModelEvaluationSliceSliceSliceSpec" }, "GoogleCloudAiplatformV1beta1ListFeatureOnlineStoresResponse": { "description": "Response message for FeatureOnlineStoreAdminService.ListFeatureOnlineStores.", "type": "object", "properties": { "featureOnlineStores": { "description": "The FeatureOnlineStores matching the request.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStore" } }, "nextPageToken": { "description": "A token, which can be sent as ListFeatureOnlineStoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1ListFeatureOnlineStoresResponse" }, "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityTraceScope": { "id": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityTraceScope", "properties": { "filter": { "items": { "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityTraceScopePredicate" }, "type": "array", "description": "Optional. A list of predicates to filter traces. Multiple predicates are combined using AND. The maximum number of predicates is 10." } }, "type": "object", "description": "If chosen, the online evaluator will evaluate single traces matching specified `filter`." }, "GenaiVertexV1beta1InteractionStatusUpdate": { "id": "GenaiVertexV1beta1InteractionStatusUpdate", "type": "object", "properties": { "status": { "type": "string", "enum": [ "UNSPECIFIED", "IN_PROGRESS", "REQUIRES_ACTION", "COMPLETED", "FAILED", "CANCELLED", "INCOMPLETE", "BUDGET_EXCEEDED", "QUEUED" ], "enumDescriptions": [ "Default value. This value is unused.", "The interaction is in progress.", "The interaction requires action/input from the user.", "The interaction is completed.", "The interaction failed.", "The interaction was cancelled.", "The interaction is completed, but contains incomplete results (e.g. hitting max_tokens).", "The interaction was halted because the token budget was exceeded.", "The interaction is queued, waiting for processing (e.g. waiting for off-peak capacity)." ] }, "interactionId": { "type": "string" } } }, "GoogleCloudAiplatformV1beta1ListModelVersionsResponse": { "type": "object", "description": "Response message for ModelService.ListModelVersions", "properties": { "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results. Pass to ListModelVersionsRequest.page_token to obtain that page." }, "models": { "type": "array", "description": "List of Model versions in the requested page. In the returned Model name field, version ID instead of regvision tag will be included.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Model" } } }, "id": "GoogleCloudAiplatformV1beta1ListModelVersionsResponse" }, "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateDefaultContainerEnvironment": { "description": "The default sandbox runtime environment for default container workloads.", "properties": { "resources": { "description": "Optional. Resource requests and limits for the default container.", "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateResourceRequirements" }, "defaultContainerCategory": { "enumDescriptions": [ "The default value. This value is unused.", "The default container image for Computer Use.", "The default container image for Shell Sandbox." ], "description": "Required. The category of the default container image.", "enum": [ "DEFAULT_CONTAINER_CATEGORY_UNSPECIFIED", "DEFAULT_CONTAINER_CATEGORY_COMPUTER_USE", "DEFAULT_CONTAINER_CATEGORY_SHELL_SANDBOX" ], "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateDefaultContainerEnvironment", "type": "object" }, "GoogleCloudAiplatformV1beta1DistillationDataStats": { "properties": { "trainingDatasetStats": { "readOnly": true, "description": "Output only. Statistics computed for the training dataset.", "$ref": "GoogleCloudAiplatformV1beta1DatasetStats" } }, "id": "GoogleCloudAiplatformV1beta1DistillationDataStats", "type": "object", "description": "Statistics for distillation prompt dataset. These statistics do not include the responses sampled from the teacher model." }, "GoogleCloudAiplatformV1beta1AssessDataRequest": { "id": "GoogleCloudAiplatformV1beta1AssessDataRequest", "type": "object", "properties": { "tuningValidationAssessmentConfig": { "$ref": "GoogleCloudAiplatformV1beta1AssessDataRequestTuningValidationAssessmentConfig", "description": "Optional. Configuration for the tuning validation assessment." }, "tuningResourceUsageAssessmentConfig": { "description": "Optional. Configuration for the tuning resource usage assessment.", "$ref": "GoogleCloudAiplatformV1beta1AssessDataRequestTuningResourceUsageAssessmentConfig" }, "geminiRequestReadConfig": { "$ref": "GoogleCloudAiplatformV1beta1GeminiRequestReadConfig", "description": "Optional. The Gemini request read config for the dataset." }, "batchPredictionResourceUsageAssessmentConfig": { "description": "Optional. Configuration for the batch prediction resource usage assessment.", "$ref": "GoogleCloudAiplatformV1beta1AssessDataRequestBatchPredictionResourceUsageAssessmentConfig" }, "batchPredictionValidationAssessmentConfig": { "description": "Optional. Configuration for the batch prediction validation assessment.", "$ref": "GoogleCloudAiplatformV1beta1AssessDataRequestBatchPredictionValidationAssessmentConfig" } }, "description": "Request message for DatasetService.AssessData. Used only for MULTIMODAL datasets." }, "GoogleCloudAiplatformV1beta1BatchReadFeatureValuesRequest": { "properties": { "csvReadInstances": { "$ref": "GoogleCloudAiplatformV1beta1CsvSource", "description": "Each read instance consists of exactly one read timestamp and one or more entity IDs identifying entities of the corresponding EntityTypes whose Features are requested. Each output instance contains Feature values of requested entities concatenated together as of the read time. An example read instance may be `foo_entity_id, bar_entity_id, 2020-01-01T10:00:00.123Z`. An example output instance may be `foo_entity_id, bar_entity_id, 2020-01-01T10:00:00.123Z, foo_entity_feature1_value, bar_entity_feature2_value`. Timestamp in each read instance must be millisecond-aligned. `csv_read_instances` are read instances stored in a plain-text CSV file. The header should be: [ENTITY_TYPE_ID1], [ENTITY_TYPE_ID2], ..., timestamp The columns can be in any order. Values in the timestamp column must use the RFC 3339 format, e.g. `2012-07-30T10:43:17.123Z`." }, "bigqueryReadInstances": { "description": "Similar to csv_read_instances, but from BigQuery source.", "$ref": "GoogleCloudAiplatformV1beta1BigQuerySource" }, "entityTypeSpecs": { "items": { "$ref": "GoogleCloudAiplatformV1beta1BatchReadFeatureValuesRequestEntityTypeSpec" }, "type": "array", "description": "Required. Specifies EntityType grouping Features to read values of and settings." }, "destination": { "$ref": "GoogleCloudAiplatformV1beta1FeatureValueDestination", "description": "Required. Specifies output location and format." }, "passThroughFields": { "description": "When not empty, the specified fields in the *_read_instances source will be joined as-is in the output, in addition to those fields from the Featurestore Entity. For BigQuery source, the type of the pass-through values will be automatically inferred. For CSV source, the pass-through values will be passed as opaque bytes.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1BatchReadFeatureValuesRequestPassThroughField" } }, "startTime": { "description": "Optional. Excludes Feature values with feature generation timestamp before this timestamp. If not set, retrieve oldest values kept in Feature Store. Timestamp, if present, must not have higher than millisecond precision.", "format": "google-datetime", "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1BatchReadFeatureValuesRequest", "description": "Request message for FeaturestoreService.BatchReadFeatureValues." }, "GoogleCloudAiplatformV1beta1CorroborateContentRequest": { "properties": { "content": { "description": "Optional. Input content to corroborate, only text format is supported for now.", "$ref": "GoogleCloudAiplatformV1beta1Content" }, "parameters": { "description": "Optional. Parameters that can be set to override default settings per request.", "$ref": "GoogleCloudAiplatformV1beta1CorroborateContentRequestParameters" }, "facts": { "type": "array", "description": "Optional. Facts used to generate the text can also be used to corroborate the text.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Fact" } } }, "type": "object", "description": "Request message for CorroborateContent.", "id": "GoogleCloudAiplatformV1beta1CorroborateContentRequest" }, "GoogleCloudAiplatformV1beta1BatchDeletePipelineJobsResponse": { "id": "GoogleCloudAiplatformV1beta1BatchDeletePipelineJobsResponse", "properties": { "pipelineJobs": { "description": "PipelineJobs deleted.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1PipelineJob" } } }, "description": "Response message for PipelineService.BatchDeletePipelineJobs.", "type": "object" }, "GenaiVertexV1beta1UrlContextResultContent": { "properties": { "result": { "items": { "$ref": "GenaiVertexV1beta1UrlContextResultContentUrlContextResult" }, "type": "array", "description": "Required. The results of the URL context." }, "isError": { "description": "Whether the URL context resulted in an error.", "type": "boolean" } }, "description": "URL context result content.", "deprecated": true, "id": "GenaiVertexV1beta1UrlContextResultContent", "type": "object" }, "GoogleCloudAiplatformV1beta1BatchCreateTensorboardRunsResponse": { "description": "Response message for TensorboardService.BatchCreateTensorboardRuns.", "type": "object", "id": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardRunsResponse", "properties": { "tensorboardRuns": { "items": { "$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" }, "type": "array", "description": "The created TensorboardRuns." } } }, "GoogleCloudAiplatformV1beta1MachineSpec": { "type": "object", "description": "Specification of a single machine.", "properties": { "gpuPartitionSize": { "type": "string", "description": "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": { "type": "string", "description": "Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/gemini-enterprise-agent-platform/machine-learning/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/gemini-enterprise-agent-platform/machine-learning/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." }, "tpuTopology": { "description": "Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: \"2x2x1\").", "type": "string" }, "acceleratorType": { "enumDescriptions": [ "Unspecified accelerator type, which means no accelerator.", "Deprecated: Nvidia Tesla K80 GPU has reached end of support, see https://cloud.google.com/compute/docs/eol/k80-eol.", "Nvidia Tesla P100 GPU.", "Nvidia Tesla V100 GPU.", "Nvidia Tesla P4 GPU.", "Nvidia Tesla T4 GPU.", "Nvidia Tesla A100 GPU.", "Nvidia A100 80GB GPU.", "Nvidia L4 GPU.", "Nvidia H100 80Gb GPU.", "Nvidia H100 Mega 80Gb GPU.", "Nvidia H200 141Gb GPU.", "Nvidia B200 GPU.", "Nvidia GB200 GPU.", "Nvidia RTX Pro 6000 GPU.", "TPU v2.", "TPU v3.", "TPU v4.", "TPU v5." ], "description": "Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.", "type": "string", "enumDeprecated": [ false, true, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false ], "enum": [ "ACCELERATOR_TYPE_UNSPECIFIED", "NVIDIA_TESLA_K80", "NVIDIA_TESLA_P100", "NVIDIA_TESLA_V100", "NVIDIA_TESLA_P4", "NVIDIA_TESLA_T4", "NVIDIA_TESLA_A100", "NVIDIA_A100_80GB", "NVIDIA_L4", "NVIDIA_H100_80GB", "NVIDIA_H100_MEGA_80GB", "NVIDIA_H200_141GB", "NVIDIA_B200", "NVIDIA_GB200", "NVIDIA_RTX_PRO_6000", "TPU_V2", "TPU_V3", "TPU_V4_POD", "TPU_V5_LITEPOD" ] }, "acceleratorCount": { "description": "The number of accelerators to attach to the machine. For [accelerator optimized machine types](https://cloud.google.com/compute/docs/accelerator-optimized-machines), One may set the accelerator_count from 1 to N for machine with N GPUs. If accelerator_count is less than or equal to N / 2, Agent Platform co-schedules the replicas of the model into the same VM to save cost. For example, if the machine type is a3-highgpu-8g, which has 8 H100 GPUs, one can set accelerator_count to 1 to 8. If accelerator_count is 1, 2, 3, or 4, Agent Platform co-schedules 8, 4, 2, or 2 replicas of the model into the same VM to save cost. When co-scheduling, CPU, memory and storage on the VM will be distributed to replicas on the VM. For example, one can expect a co-scheduled replica requesting 2 GPUs out of a 8-GPU VM will receive 25% of the CPU, memory and storage of the VM. Note that the feature is not compatible with multihost_gpu_node_count. When multihost_gpu_node_count is set, the co-scheduling will not be enabled.", "format": "int32", "type": "integer" }, "minGpuDriverVersion": { "description": "Optional. Immutable. The minimum GPU driver version that this machine requires. For example, \"535.104.06\". If not specified, the default GPU driver version will be used by the underlying infrastructure.", "type": "string" }, "multihostGpuNodeCount": { "format": "int32", "type": "integer", "description": "Optional. Immutable. The number of nodes per replica for multihost GPU deployments." }, "reservationAffinity": { "$ref": "GoogleCloudAiplatformV1beta1ReservationAffinity", "description": "Optional. Immutable. Configuration controlling how this resource pool consumes reservation." } }, "id": "GoogleCloudAiplatformV1beta1MachineSpec" }, "GoogleCloudAiplatformV1beta1Chunk": { "type": "object", "id": "GoogleCloudAiplatformV1beta1Chunk", "description": "Container for bytes-encoded data such as video frame, audio sample, or a complete binary/text data.", "properties": { "data": { "description": "Required. The data in the chunk.", "type": "string", "format": "byte" }, "mimeType": { "description": "Required. Mime type of the chunk data. See https://www.iana.org/assignments/media-types/media-types.xhtml for the full list.", "type": "string" }, "metadata": { "description": "Optional. Metadata that is associated with the data in the payload.", "$ref": "GoogleCloudAiplatformV1beta1Metadata" } } }, "GoogleCloudAiplatformV1beta1OutputFieldSpec": { "properties": { "fieldName": { "type": "string", "description": "Required. The name of this field in the generated synthetic data, such as \"email_subject\" or \"customer_review\"." }, "guidance": { "description": "Optional. Specific instructions for the large language model on how to generate content for this particular field. While the LLM can sometimes infer content from the field name, providing explicit guidance is preferred. For example, for a field named \"review\", the guidance could be \"A positive review about a coffee maker.\"", "type": "string" }, "fieldType": { "enumDescriptions": [ "The field type is not specified. Defaults to CONTENT.", "The field can contain any type of content, including text, images, and audio.", "The field contains only text.", "The field contains image data.", "The field contains audio data." ], "description": "Optional. The data type of the field. Defaults to CONTENT if not set.", "type": "string", "enum": [ "FIELD_TYPE_UNSPECIFIED", "CONTENT", "TEXT", "IMAGE", "AUDIO" ] } }, "id": "GoogleCloudAiplatformV1beta1OutputFieldSpec", "type": "object", "description": "Specifies the properties of a single field that are included in each generated synthetic example. This helps the model understand what kind of data to generate for each field." }, "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponse": { "type": "object", "id": "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponse", "properties": { "dataKey": { "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDataKey", "description": "The data key associated with this response. Will only be populated for FeatureOnlineStoreService.StreamingFetchFeatureValues RPCs." }, "keyValues": { "description": "Feature values in KeyValue format.", "$ref": "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponseFeatureNameValuePairList" }, "protoStruct": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Feature values in proto Struct format." } }, "description": "Response message for FeatureOnlineStoreService.FetchFeatureValues" }, "GoogleCloudAiplatformV1beta1PredefinedSplit": { "description": "Assigns input data to training, validation, and test sets based on the value of a provided key. Supported only for tabular Datasets.", "properties": { "key": { "description": "Required. The key is a name of one of the Dataset's data columns. The value of the key (either the label's value or value in the column) must be one of {`training`, `validation`, `test`}, and it defines to which set the given piece of data is assigned. If for a piece of data the key is not present or has an invalid value, that piece is ignored by the pipeline.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1PredefinedSplit", "type": "object" }, "GoogleCloudAiplatformV1beta1Featurestore": { "properties": { "state": { "enum": [ "STATE_UNSPECIFIED", "STABLE", "UPDATING" ], "readOnly": true, "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "State when the featurestore configuration is not being updated and the fields reflect the current configuration of the featurestore. The featurestore is usable in this state.", "The state of the featurestore configuration when it is being updated. During an update, the fields reflect either the original configuration or the updated configuration of the featurestore. For example, `online_serving_config.fixed_node_count` can take minutes to update. While the update is in progress, the featurestore is in the UPDATING state, and the value of `fixed_node_count` can be the original value or the updated value, depending on the progress of the operation. Until the update completes, the actual number of nodes can still be the original value of `fixed_node_count`. The featurestore is still usable in this state." ], "description": "Output only. State of the featurestore." }, "encryptionSpec": { "description": "Optional. Customer-managed encryption key spec for data storage. If set, both of the online and offline data storage will be secured by this key.", "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec" }, "satisfiesPzi": { "type": "boolean", "readOnly": true, "description": "Output only. Reserved for future use." }, "createTime": { "description": "Output only. Timestamp when this Featurestore was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "onlineServingConfig": { "$ref": "GoogleCloudAiplatformV1beta1FeaturestoreOnlineServingConfig", "description": "Optional. Config for online storage resources. The field should not co-exist with the field of `OnlineStoreReplicationConfig`. If both of it and OnlineStoreReplicationConfig are unset, the feature store will not have an online store and cannot be used for online serving." }, "etag": { "type": "string", "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens." }, "satisfiesPzs": { "type": "boolean", "description": "Output only. Reserved for future use.", "readOnly": true }, "onlineStorageTtlDays": { "type": "integer", "description": "Optional. TTL in days for feature values that will be stored in online serving storage. The Feature Store online storage periodically removes obsolete feature values older than `online_storage_ttl_days` since the feature generation time. Note that `online_storage_ttl_days` should be less than or equal to `offline_storage_ttl_days` for each EntityType under a featurestore. If not set, default to 4000 days", "format": "int32" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. The labels with user-defined metadata to organize your Featurestore. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one Featurestore(System labels are excluded).\" System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable." }, "name": { "readOnly": true, "type": "string", "description": "Output only. Name of the Featurestore. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`" }, "updateTime": { "readOnly": true, "description": "Output only. Timestamp when this Featurestore was last updated.", "format": "google-datetime", "type": "string" } }, "description": "Vertex AI Feature Store provides a centralized repository for organizing, storing, and serving ML features. The Featurestore is a top-level container for your features and their values.", "id": "GoogleCloudAiplatformV1beta1Featurestore", "type": "object" }, "GoogleCloudAiplatformV1beta1ModelMonitorModelMonitoringTargetVertexModelSource": { "id": "GoogleCloudAiplatformV1beta1ModelMonitorModelMonitoringTargetVertexModelSource", "type": "object", "properties": { "modelVersionId": { "type": "string", "description": "Model version id." }, "model": { "type": "string", "description": "Model resource name. Format: projects/{project}/locations/{location}/models/{model}." } }, "description": "Model in Vertex AI Model Registry." }, "GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorer": { "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorer", "properties": { "autoraterConfig": { "$ref": "GoogleCloudAiplatformV1beta1AutoraterConfig", "description": "Autorater config for classification based autorater" }, "exactMatchScorer": { "description": "Scores autorater responses by using string match reward scorer.", "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorerExactMatchScorer" }, "autoraterResponseParseConfig": { "description": "Parses autorater returned response for scoring. For example, if the autorater response has reward stored in the `2.0` block, defining a parsing response config using regex `\".*(.*?)\"` will return a score `\"2.0\"`.", "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningParseResponseConfig" }, "autoraterPrompt": { "description": "The prompt for an autorater to scorer the parsed sample response. This field supports the following placeholders that will be replaced before scoring: - {{prompt}} - {{response}} - {{system_instruction}} - {{references.key}} ", "type": "string" }, "parsedResponseConversionScorer": { "description": "Scores autorater responses by directly converting parsed autorater response to a float reward. Note: Reward is clipped to be within `[-1, 1]`, i.e., `reward = max(min(reward, 1.0), -1.0)`.", "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorerParsedResponseConversionScorer" } }, "type": "object", "description": "ReinforcementTuningAutoraterScorer is used to score parsed responses for classification based autorater use cases. For example, for math problems, users can use classification based autorater to calculate rewards based on the autorater parsed response against a reference answer." }, "GoogleCloudAiplatformV1beta1ToolGoogleSearchSearchTypes": { "properties": { "webSearch": { "$ref": "GoogleCloudAiplatformV1beta1ToolGoogleSearchWebSearch", "description": "Optional. Setting this field enables web search. Only text results are returned." }, "imageSearch": { "$ref": "GoogleCloudAiplatformV1beta1ToolGoogleSearchImageSearch", "description": "Optional. Setting this field enables image search. Image bytes are returned." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ToolGoogleSearchSearchTypes", "description": "Different types of search that can be enabled on the GoogleSearch tool." }, "GenaiVertexV1beta1PlaceCitation": { "description": "A place citation annotation.", "properties": { "url": { "type": "string", "description": "URI reference of the place." }, "reviewSnippets": { "description": "Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.", "type": "array", "items": { "$ref": "GenaiVertexV1beta1ReviewSnippet" } }, "name": { "type": "string", "description": "Title of the place." }, "placeId": { "type": "string", "description": "The ID of the place, in `places/{place_id}` format." } }, "type": "object", "id": "GenaiVertexV1beta1PlaceCitation" }, "GoogleCloudAiplatformV1beta1AppendA2aTaskEventsResponse": { "type": "object", "description": "Response message for AppendA2aTaskEvents.", "properties": { "generation": { "type": "string", "description": "Task generation matching the last event", "format": "int64" } }, "id": "GoogleCloudAiplatformV1beta1AppendA2aTaskEventsResponse" }, "GenaiVertexV1beta1UrlContextCallStep": { "properties": { "arguments": { "$ref": "GenaiVertexV1beta1UrlContextCallStepUrlContextCallStepArguments", "description": "Required. The arguments to pass to the URL context." } }, "type": "object", "description": "URL context call step.", "id": "GenaiVertexV1beta1UrlContextCallStep" }, "GoogleCloudAiplatformV1beta1BatchMigrateResourcesOperationMetadataPartialResult": { "type": "object", "properties": { "dataset": { "description": "Migrated dataset resource name.", "type": "string" }, "model": { "description": "Migrated model resource name.", "type": "string" }, "error": { "description": "The error result of the migration request in case of failure.", "$ref": "GoogleRpcStatus" }, "request": { "$ref": "GoogleCloudAiplatformV1beta1MigrateResourceRequest", "description": "It's the same as the value in BatchMigrateResourcesRequest.migrate_resource_requests." } }, "id": "GoogleCloudAiplatformV1beta1BatchMigrateResourcesOperationMetadataPartialResult", "description": "Represents a partial result in batch migration operation for one MigrateResourceRequest." }, "GoogleCloudAiplatformV1beta1ToolParameterKVMatchMetricValue": { "type": "object", "description": "Tool parameter key value match metric value for an instance.", "id": "GoogleCloudAiplatformV1beta1ToolParameterKVMatchMetricValue", "properties": { "score": { "readOnly": true, "description": "Output only. Tool parameter key value match score.", "format": "float", "type": "number" } } }, "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentConfigTools": { "type": "object", "id": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentConfigTools", "properties": { "tool": { "description": "Optional. List of tools: each tool can have multiple function declarations.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Tool" }, "type": "array" } }, "description": "Represents a list of tools for an agent." }, "GoogleCloudAiplatformV1beta1BatchCreateFeaturesResponse": { "id": "GoogleCloudAiplatformV1beta1BatchCreateFeaturesResponse", "type": "object", "description": "Response message for FeaturestoreService.BatchCreateFeatures.", "properties": { "features": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Feature" }, "type": "array", "description": "The Features created." } } }, "GoogleCloudAiplatformV1beta1GeminiRequestReadConfig": { "properties": { "assembledRequestColumnName": { "type": "string", "description": "Optional. Column name in the dataset table that contains already fully assembled Gemini requests." }, "templateConfig": { "description": "Gemini request template with placeholders.", "$ref": "GoogleCloudAiplatformV1beta1GeminiTemplateConfig" } }, "description": "Configuration for how to read Gemini requests from a multimodal dataset.", "id": "GoogleCloudAiplatformV1beta1GeminiRequestReadConfig", "type": "object" }, "GoogleCloudAiplatformV1beta1RagManagedDbConfigSpanner": { "properties": { "scaled": { "$ref": "GoogleCloudAiplatformV1beta1RagManagedDbConfigScaled", "description": "Sets the RagManagedDb to the Scaled tier." }, "basic": { "description": "Sets the RagManagedDb to the Basic tier. This is the default tier for Spanner mode if not explicitly chosen.", "$ref": "GoogleCloudAiplatformV1beta1RagManagedDbConfigBasic" }, "unprovisioned": { "description": "Sets the RagManagedDb to the Unprovisioned tier.", "$ref": "GoogleCloudAiplatformV1beta1RagManagedDbConfigUnprovisioned" } }, "description": "Message to configure the Spanner database used by RagManagedDb.", "id": "GoogleCloudAiplatformV1beta1RagManagedDbConfigSpanner", "type": "object" }, "GoogleCloudAiplatformV1beta1DatasetDistributionDistributionBucket": { "description": "Dataset bucket used to create a histogram for the distribution given a population of values.", "id": "GoogleCloudAiplatformV1beta1DatasetDistributionDistributionBucket", "type": "object", "properties": { "left": { "description": "Output only. Left bound of the bucket.", "format": "double", "type": "number", "readOnly": true }, "count": { "format": "int64", "type": "string", "description": "Output only. Number of values in the bucket.", "readOnly": true }, "right": { "description": "Output only. Right bound of the bucket.", "type": "number", "format": "double", "readOnly": true } } }, "GoogleCloudAiplatformV1beta1ExactMatchSpec": { "description": "Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0.", "type": "object", "id": "GoogleCloudAiplatformV1beta1ExactMatchSpec", "properties": {} }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs": { "properties": {}, "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextExtractionInputs", "type": "object" }, "GoogleCloudAiplatformV1beta1ListHyperparameterTuningJobsResponse": { "description": "Response message for JobService.ListHyperparameterTuningJobs", "type": "object", "properties": { "hyperparameterTuningJobs": { "description": "List of HyperparameterTuningJobs in the requested page. HyperparameterTuningJob.trials of the jobs will be not be returned.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1HyperparameterTuningJob" } }, "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results. Pass to ListHyperparameterTuningJobsRequest.page_token to obtain that page." } }, "id": "GoogleCloudAiplatformV1beta1ListHyperparameterTuningJobsResponse" }, "GoogleCloudAiplatformV1beta1UndeployIndexRequest": { "properties": { "deployedIndexId": { "description": "Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.", "type": "string" } }, "type": "object", "description": "Request message for IndexEndpointService.UndeployIndex.", "id": "GoogleCloudAiplatformV1beta1UndeployIndexRequest" }, "GoogleCloudAiplatformV1beta1ReinforcementTuningUserDatasetExamples": { "type": "object", "description": "Sample reinforcement tuning user data in the training dataset. The contents are truncated for better UI showing.", "properties": { "userDatasetExamples": { "description": "List of user datasset examples showing to user.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningExample" }, "type": "array" } }, "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningUserDatasetExamples" }, "GoogleCloudAiplatformV1beta1PublisherModelCallToActionViewRestApi": { "id": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionViewRestApi", "properties": { "title": { "type": "string", "description": "Required. The title of the view rest API." }, "documentations": { "description": "Required.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelDocumentation" } } }, "type": "object", "description": "Rest API docs." }, "GoogleCloudAiplatformV1beta1MetadataStoreDataplexConfig": { "description": "Represents Dataplex integration settings.", "type": "object", "id": "GoogleCloudAiplatformV1beta1MetadataStoreDataplexConfig", "properties": { "enabledPipelinesLineage": { "type": "boolean", "description": "Optional. Whether or not Data Lineage synchronization is enabled for Vertex Pipelines." } } }, "GoogleCloudAiplatformV1beta1TFRecordDestination": { "description": "The storage details for TFRecord output content.", "properties": { "gcsDestination": { "description": "Required. Google Cloud Storage location.", "$ref": "GoogleCloudAiplatformV1beta1GcsDestination" } }, "id": "GoogleCloudAiplatformV1beta1TFRecordDestination", "type": "object" }, "GoogleCloudAiplatformV1beta1ExtensionOperation": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ExtensionOperation", "description": "Operation of an extension.", "properties": { "operationId": { "type": "string", "description": "Operation ID that uniquely identifies the operations among the extension. See: \"Operation Object\" in https://swagger.io/specification/. This field is parsed from the OpenAPI spec. For HTTP extensions, if it does not exist in the spec, we will generate one from the HTTP method and path." }, "functionDeclaration": { "description": "Output only. Structured representation of a function declaration as defined by the OpenAPI Spec.", "$ref": "GoogleCloudAiplatformV1beta1FunctionDeclaration", "readOnly": true } } }, "GoogleCloudAiplatformV1beta1SchemaPredictPredictionTimeSeriesForecastingPredictionResult": { "description": "Prediction output format for Time Series Forecasting.", "id": "GoogleCloudAiplatformV1beta1SchemaPredictPredictionTimeSeriesForecastingPredictionResult", "type": "object", "properties": { "tftFeatureImportance": { "description": "Only use these if TFt is enabled.", "$ref": "GoogleCloudAiplatformV1beta1SchemaPredictPredictionTftFeatureImportance" }, "quantileValues": { "items": { "format": "float", "type": "number" }, "description": "Quantile values.", "type": "array" }, "quantilePredictions": { "description": "Quantile predictions, in 1-1 correspondence with quantile_values.", "items": { "type": "number", "format": "float" }, "type": "array" }, "value": { "format": "float", "description": "The regression value.", "type": "number" } } }, "GoogleCloudAiplatformV1beta1PublisherModelCallToActionOpenNotebooks": { "properties": { "notebooks": { "items": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences" }, "type": "array", "description": "Required. Regional resource references to notebooks." } }, "description": "Open notebooks.", "type": "object", "id": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionOpenNotebooks" }, "GoogleCloudAiplatformV1beta1PredictLongRunningResponse": { "description": "Response message for [PredictionService.PredictLongRunning]", "properties": { "generateVideoResponse": { "$ref": "GoogleCloudAiplatformV1beta1GenerateVideoResponse", "description": "The response of the video generation prediction." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1PredictLongRunningResponse" }, "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveConfigExplanationConfig": { "id": "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveConfigExplanationConfig", "description": "The config for integrating with Vertex Explainable AI. Only applicable if the Model has explanation_spec populated.", "type": "object", "properties": { "explanationBaseline": { "description": "Predictions generated by the BatchPredictionJob using baseline dataset.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline" }, "enableFeatureAttributes": { "type": "boolean", "description": "If want to analyze the Vertex Explainable AI feature attribute scores or not. If set to true, Vertex AI will log the feature attributions from explain response and do the skew/drift detection for them." } } }, "GoogleCloudAiplatformV1beta1StreamingPredictRequest": { "properties": { "inputs": { "description": "The prediction input.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Tensor" } }, "parameters": { "description": "The parameters that govern the prediction.", "$ref": "GoogleCloudAiplatformV1beta1Tensor" } }, "description": "Request message for PredictionService.StreamingPredict. The first message must contain endpoint field and optionally input. The subsequent messages must contain input.", "type": "object", "id": "GoogleCloudAiplatformV1beta1StreamingPredictRequest" }, "GoogleCloudAiplatformV1beta1AutoraterConfig": { "properties": { "flipEnabled": { "description": "Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.", "type": "boolean" }, "autoraterModel": { "description": "Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "type": "string" }, "generationConfig": { "description": "Optional. Configuration options for model generation and outputs.", "$ref": "GoogleCloudAiplatformV1beta1GenerationConfig" }, "samplingCount": { "description": "Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudAiplatformV1beta1AutoraterConfig", "description": "The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset.", "type": "object" }, "GenaiVertexV1beta1FileSearchCallStep": { "id": "GenaiVertexV1beta1FileSearchCallStep", "description": "File Search call step.", "type": "object", "properties": {} }, "GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig": { "properties": { "speakerVoiceConfigs": { "description": "Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.", "items": { "$ref": "GoogleCloudAiplatformV1beta1SpeakerVoiceConfig" }, "type": "array" } }, "type": "object", "description": "Configuration for a multi-speaker text-to-speech request.", "id": "GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig" }, "GoogleCloudAiplatformV1beta1DeleteFeatureValuesRequestSelectEntity": { "properties": { "entityIdSelector": { "description": "Required. Selectors choosing feature values of which entity id to be deleted from the EntityType.", "$ref": "GoogleCloudAiplatformV1beta1EntityIdSelector" } }, "description": "Message to select entity. If an entity id is selected, all the feature values corresponding to the entity id will be deleted, including the entityId.", "id": "GoogleCloudAiplatformV1beta1DeleteFeatureValuesRequestSelectEntity", "type": "object" }, "GoogleCloudAiplatformV1beta1UpdateFeatureOperationMetadata": { "description": "Details of operations that perform update Feature.", "properties": { "genericMetadata": { "description": "Operation metadata for Feature Update.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1UpdateFeatureOperationMetadata" }, "GenaiVertexV1beta1UrlContextCallStepUrlContextCallStepArguments": { "type": "object", "id": "GenaiVertexV1beta1UrlContextCallStepUrlContextCallStepArguments", "properties": { "urls": { "description": "The URLs to fetch.", "type": "array", "items": { "type": "string" } } }, "description": "The arguments to pass to the URL context." }, "GoogleCloudAiplatformV1beta1CreateExtensionControllerOperationMetadata": { "id": "GoogleCloudAiplatformV1beta1CreateExtensionControllerOperationMetadata", "description": "Details of ExtensionControllerService.CreateExtensionController operation.", "type": "object", "properties": { "genericMetadata": { "description": "The common part of the operation metadata.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } } }, "GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadataGcsSource": { "type": "object", "properties": { "uri": { "description": "Cloud Storage URI of one or more files. Only CSV files are supported. The first line of the CSV file is used as the header. If there are multiple files, the header is the first line of the lexicographically first file, the other files must either contain the exact same header or omit the header.", "type": "array", "items": { "type": "string" } } }, "id": "GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadataGcsSource" }, "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecImageSpec": { "description": "The image spec for building an image (within a single build step), based on the config file (i.e. Dockerfile) in the source directory.", "type": "object", "properties": { "buildArgs": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Optional. Build arguments to be used. They will be passed through --build-arg flags." } }, "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecImageSpec" }, "GoogleCloudAiplatformV1beta1ExportPublisherModelOperationMetadata": { "type": "object", "description": "Runtime operation information for ModelGardenService.ExportPublisherModel.", "id": "GoogleCloudAiplatformV1beta1ExportPublisherModelOperationMetadata", "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "The operation generic information." } } }, "GoogleCloudAiplatformV1beta1StructuredMemoryConfig": { "id": "GoogleCloudAiplatformV1beta1StructuredMemoryConfig", "description": "Represents configuration for organizing structured memories for a particular scope.", "type": "object", "properties": { "scopeKeys": { "description": "Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank.", "type": "array", "items": { "type": "string" } }, "schemaConfigs": { "type": "array", "description": "Optional. Represents configuration of the structured memories' schemas.", "items": { "$ref": "GoogleCloudAiplatformV1beta1StructuredMemoryConfigSchemaConfig" } } } }, "GoogleCloudAiplatformV1beta1SchemaPredictParamsVideoActionRecognitionPredictionParams": { "properties": { "maxPredictions": { "format": "int32", "type": "integer", "description": "The model only returns up to that many top, by confidence score, predictions per frame of the video. If this number is very high, the Model may return fewer predictions per frame. Default value is 50." }, "confidenceThreshold": { "format": "float", "type": "number", "description": "The Model only returns predictions with at least this confidence score. Default value is 0.0" } }, "type": "object", "description": "Prediction model parameters for Video Action Recognition.", "id": "GoogleCloudAiplatformV1beta1SchemaPredictParamsVideoActionRecognitionPredictionParams" }, "GoogleCloudAiplatformV1beta1Tensor": { "properties": { "floatVal": { "items": { "type": "number", "format": "float" }, "type": "array", "description": "FLOAT" }, "bytesVal": { "description": "STRING", "items": { "type": "string", "format": "byte" }, "type": "array" }, "doubleVal": { "items": { "type": "number", "format": "double" }, "type": "array", "description": "DOUBLE" }, "tensorVal": { "type": "string", "description": "Serialized raw tensor content.", "format": "byte" }, "shape": { "type": "array", "items": { "type": "string", "format": "int64" }, "description": "Shape of the tensor." }, "listVal": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Tensor" }, "description": "A list of tensor values.", "type": "array" }, "structVal": { "description": "A map of string to tensor.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1Tensor" } }, "intVal": { "description": "INT_8 INT_16 INT_32", "type": "array", "items": { "type": "integer", "format": "int32" } }, "dtype": { "enum": [ "DATA_TYPE_UNSPECIFIED", "BOOL", "STRING", "FLOAT", "DOUBLE", "INT8", "INT16", "INT32", "INT64", "UINT8", "UINT16", "UINT32", "UINT64" ], "type": "string", "description": "The data type of tensor.", "enumDescriptions": [ "Not a legal value for DataType. Used to indicate a DataType field has not been set.", "Data types that all computation devices are expected to be capable to support.", "", "", "", "", "", "", "", "", "", "", "" ] }, "uintVal": { "items": { "format": "uint32", "type": "integer" }, "type": "array", "description": "UINT8 UINT16 UINT32" }, "boolVal": { "items": { "type": "boolean" }, "type": "array", "description": "Type specific representations that make it easy to create tensor protos in all languages. Only the representation corresponding to \"dtype\" can be set. The values hold the flattened representation of the tensor in row major order. BOOL" }, "int64Val": { "description": "INT64", "items": { "format": "int64", "type": "string" }, "type": "array" }, "stringVal": { "type": "array", "description": "STRING", "items": { "type": "string" } }, "uint64Val": { "description": "UINT64", "type": "array", "items": { "type": "string", "format": "uint64" } } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1Tensor", "description": "A tensor value type." }, "GoogleCloudAiplatformV1beta1FunctionResponsePart": { "type": "object", "id": "GoogleCloudAiplatformV1beta1FunctionResponsePart", "description": "A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.", "properties": { "fileData": { "description": "URI based data.", "$ref": "GoogleCloudAiplatformV1beta1FunctionResponseFileData" }, "inlineData": { "description": "Inline media bytes.", "$ref": "GoogleCloudAiplatformV1beta1FunctionResponseBlob" } } }, "GoogleCloudAiplatformV1beta1ModelMonitoringStats": { "description": "Represents the collection of statistics for a metric.", "id": "GoogleCloudAiplatformV1beta1ModelMonitoringStats", "type": "object", "properties": { "tabularStats": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringTabularStats", "description": "Generated tabular statistics." } } }, "GoogleCloudAiplatformV1beta1SupervisedTuningSpec": { "description": "Tuning Spec for Supervised Tuning for first party models.", "type": "object", "properties": { "tuningMode": { "type": "string", "enum": [ "TUNING_MODE_UNSPECIFIED", "TUNING_MODE_FULL", "TUNING_MODE_PEFT_ADAPTER" ], "description": "Tuning mode.", "enumDescriptions": [ "Tuning mode is unspecified.", "Full fine-tuning mode.", "PEFT adapter tuning mode." ] }, "hyperParameters": { "$ref": "GoogleCloudAiplatformV1beta1SupervisedHyperParameters", "description": "Optional. Hyperparameters for SFT." }, "evaluationConfig": { "description": "Optional. Evaluation Config for Tuning Job.", "$ref": "GoogleCloudAiplatformV1beta1EvaluationConfig" }, "validationDatasetUri": { "description": "Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.", "type": "string" }, "exportLastCheckpointOnly": { "type": "boolean", "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." }, "trainingDatasetUri": { "description": "Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1SupervisedTuningSpec" }, "GoogleCloudAiplatformV1beta1RayMetricSpec": { "id": "GoogleCloudAiplatformV1beta1RayMetricSpec", "type": "object", "properties": { "enableUsageStatsCollection": { "type": "boolean", "description": "Optional. Flag to enable the Ray usage stats collection by Anyscale. https://docs.ray.io/en/latest/cluster/usage-stats.html#usage-stats-collection Disable by default." }, "disabled": { "description": "Optional. Flag to disable the Ray metrics collection.", "type": "boolean" } }, "description": "Configuration for the Ray metrics." }, "GoogleCloudAiplatformV1beta1ListOptimalTrialsResponse": { "properties": { "optimalTrials": { "description": "The pareto-optimal Trials for multiple objective Study or the optimal trial for single objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency", "items": { "$ref": "GoogleCloudAiplatformV1beta1Trial" }, "type": "array" } }, "id": "GoogleCloudAiplatformV1beta1ListOptimalTrialsResponse", "description": "Response message for VizierService.ListOptimalTrials.", "type": "object" }, "GenaiVertexV1beta1ServerToolResultDelta": { "id": "GenaiVertexV1beta1ServerToolResultDelta", "properties": { "codeExecutionResult": { "$ref": "GenaiVertexV1beta1CodeExecutionResultDelta" }, "mcpServerToolResult": { "$ref": "GenaiVertexV1beta1McpServerToolResultDelta" }, "googleMapsResult": { "$ref": "GenaiVertexV1beta1GoogleMapsResultDelta" }, "fileSearchResult": { "$ref": "GenaiVertexV1beta1FileSearchResultDelta" }, "signature": { "type": "string", "format": "byte", "description": "A signature hash for backend validation." }, "retrievalResult": { "$ref": "GenaiVertexV1beta1RetrievalResultDelta" }, "googleSearchResult": { "$ref": "GenaiVertexV1beta1GoogleSearchResultDelta" }, "urlContextResult": { "$ref": "GenaiVertexV1beta1UrlContextResultDelta" }, "processingResult": { "$ref": "GenaiVertexV1beta1ProcessingResultDelta" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1NetworkSpec": { "description": "Network spec.", "id": "GoogleCloudAiplatformV1beta1NetworkSpec", "type": "object", "properties": { "subnetwork": { "description": "The name of the subnet that this instance is in. Format: `projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}`", "type": "string" }, "enableInternetAccess": { "description": "Whether to enable public internet access. Default false.", "type": "boolean" }, "network": { "type": "string", "description": "The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)" } } }, "GoogleCloudAiplatformV1beta1RagQueryRanking": { "id": "GoogleCloudAiplatformV1beta1RagQueryRanking", "type": "object", "properties": { "alpha": { "type": "number", "description": "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.", "format": "float" } }, "description": "Configurations for hybrid search results ranking." }, "GoogleCloudAiplatformV1beta1IntegratedGradientsAttribution": { "description": "An attribution method that computes the Aumann-Shapley value taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365", "properties": { "smoothGradConfig": { "$ref": "GoogleCloudAiplatformV1beta1SmoothGradConfig", "description": "Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf" }, "blurBaselineConfig": { "description": "Config for IG with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383", "$ref": "GoogleCloudAiplatformV1beta1BlurBaselineConfig" }, "stepCount": { "format": "int32", "type": "integer", "description": "Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is within the desired error range. Valid range of its value is [1, 100], inclusively." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1IntegratedGradientsAttribution" }, "GoogleCloudAiplatformV1beta1ReadFeatureValuesRequest": { "type": "object", "description": "Request message for FeaturestoreOnlineServingService.ReadFeatureValues.", "properties": { "featureSelector": { "$ref": "GoogleCloudAiplatformV1beta1FeatureSelector", "description": "Required. Selector choosing Features of the target EntityType." }, "entityId": { "type": "string", "description": "Required. ID for a specific entity. For example, for a machine learning model predicting user clicks on a website, an entity ID could be `user_123`." } }, "id": "GoogleCloudAiplatformV1beta1ReadFeatureValuesRequest" }, "GoogleCloudAiplatformV1beta1IndexDatapointSparseEmbedding": { "properties": { "dimensions": { "items": { "type": "string", "format": "int64" }, "type": "array", "description": "Required. The list of indexes for the embedding values of the sparse vector." }, "values": { "items": { "type": "number", "format": "float" }, "description": "Required. The list of embedding values of the sparse vector.", "type": "array" } }, "description": "Feature embedding vector for sparse index. An array of numbers whose values are located in the specified dimensions.", "id": "GoogleCloudAiplatformV1beta1IndexDatapointSparseEmbedding", "type": "object" }, "GoogleCloudAiplatformV1beta1ListEntityTypesResponse": { "type": "object", "description": "Response message for FeaturestoreService.ListEntityTypes.", "properties": { "nextPageToken": { "description": "A token, which can be sent as ListEntityTypesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "entityTypes": { "description": "The EntityTypes matching the request.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1EntityType" } } }, "id": "GoogleCloudAiplatformV1beta1ListEntityTypesResponse" }, "GoogleCloudAiplatformV1beta1DirectPredictResponse": { "description": "Response message for PredictionService.DirectPredict.", "id": "GoogleCloudAiplatformV1beta1DirectPredictResponse", "type": "object", "properties": { "outputs": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Tensor" }, "type": "array", "description": "The prediction output." }, "parameters": { "$ref": "GoogleCloudAiplatformV1beta1Tensor", "description": "The parameters that govern the prediction." } } }, "GoogleCloudAiplatformV1beta1RawPredictRequest": { "id": "GoogleCloudAiplatformV1beta1RawPredictRequest", "description": "Request message for PredictionService.RawPredict.", "properties": { "httpBody": { "$ref": "GoogleApiHttpBody", "description": "The prediction input. Supports HTTP headers and arbitrary data payload. A DeployedModel may have an upper limit on the number of instances it supports per request. When this limit it is exceeded for an AutoML model, the RawPredict method returns an error. When this limit is exceeded for a custom-trained model, the behavior varies depending on the model. You can specify the schema for each instance in the predict_schemata.instance_schema_uri field when you create a Model. This schema applies when you deploy the `Model` as a `DeployedModel` to an Endpoint and use the `RawPredict` method." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaMultimodalDatasetMetadata": { "description": "The metadata of Multimodal Datasets.", "type": "object", "properties": { "geminiRequestReadConfig": { "$ref": "GoogleCloudAiplatformV1beta1GeminiRequestReadConfig", "description": "The configuration for how to read Gemini requests from the dataset." }, "inputConfig": { "description": "Specifies the input source and configuration.", "$ref": "GoogleCloudAiplatformV1beta1SchemaMultimodalDatasetMetadataMultimodalDatasetInputConfig" }, "keyColumnName": { "type": "string", "description": "The name of the column in the BigQuery table that contains the keys of the rows." } }, "id": "GoogleCloudAiplatformV1beta1SchemaMultimodalDatasetMetadata" }, "GoogleCloudAiplatformV1beta1ReasoningEngineRuntimeRevision": { "properties": { "spec": { "description": "Immutable. Configurations of the ReasoningEngineRuntimeRevision. Contains only revision specific fields.", "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpec" }, "createTime": { "description": "Output only. Timestamp when this ReasoningEngineRuntimeRevision was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "name": { "description": "Identifier. The resource name of the ReasoningEngineRuntimeRevision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/runtimeRevisions/{runtime_revision}`", "type": "string" }, "state": { "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "DEPRECATED" ], "readOnly": true, "description": "Output only. The state of the revision.", "type": "string", "enumDescriptions": [ "The unspecified state.", "Is deployed and ready to be used.", "Is deprecated, may not be used, only preserved for historical purposes." ] } }, "description": "ReasoningEngineRuntimeRevision is a specific version of the runtime related part of ReasoningEngine. Contains only the fields that are revision specific.", "type": "object", "id": "GoogleCloudAiplatformV1beta1ReasoningEngineRuntimeRevision" }, "GenaiVertexV1beta1TextContentAnnotation": { "type": "object", "description": "Citation information for model-generated content.", "properties": { "wordInfo": { "$ref": "GenaiVertexV1beta1WordInfo", "description": "Word-level ASR annotation with timing and speaker info." }, "startIndex": { "type": "integer", "description": "Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.", "format": "int32" }, "urlCitation": { "$ref": "GenaiVertexV1beta1UrlCitation", "description": "NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation." }, "endIndex": { "format": "int32", "type": "integer", "description": "End of the attributed segment, exclusive." }, "fileCitation": { "$ref": "GenaiVertexV1beta1FileCitation", "description": "A file citation annotation." }, "placeCitation": { "$ref": "GenaiVertexV1beta1PlaceCitation", "description": "A place citation annotation." } }, "id": "GenaiVertexV1beta1TextContentAnnotation" }, "GoogleCloudAiplatformV1beta1Port": { "id": "GoogleCloudAiplatformV1beta1Port", "type": "object", "description": "Represents a network port in a container.", "properties": { "containerPort": { "format": "int32", "type": "integer", "description": "The number of the port to expose on the pod's IP address. Must be a valid port number, between 1 and 65535 inclusive." } } }, "GoogleCloudAiplatformV1beta1FeatureStatsAnomaly": { "type": "object", "id": "GoogleCloudAiplatformV1beta1FeatureStatsAnomaly", "description": "Stats and Anomaly generated at specific timestamp for specific Feature. The start_time and end_time are used to define the time range of the dataset that current stats belongs to, e.g. prediction traffic is bucketed into prediction datasets by time window. If the Dataset is not defined by time window, start_time = end_time. Timestamp of the stats and anomalies always refers to end_time. Raw stats and anomalies are stored in stats_uri or anomaly_uri in the tensorflow defined protos. Field data_stats contains almost identical information with the raw stats in Vertex AI defined proto, for UI to display.", "properties": { "anomalyUri": { "type": "string", "description": "Path of the anomaly file for current feature values in Cloud Storage bucket. Format: gs:////anomalies. Example: gs://monitoring_bucket/feature_name/anomalies. Stats are stored as binary format with Protobuf message Anoamlies are stored as binary format with Protobuf message [tensorflow.metadata.v0.AnomalyInfo] (https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/anomalies.proto)." }, "distributionDeviation": { "description": "Deviation from the current stats to baseline stats. 1. For categorical feature, the distribution distance is calculated by L-inifinity norm. 2. For numerical feature, the distribution distance is calculated by Jensen–Shannon divergence.", "format": "double", "type": "number" }, "endTime": { "description": "The end timestamp of window where stats were generated. For objectives where time window doesn't make sense (e.g. Featurestore Snapshot Monitoring), end_time indicates the timestamp of the data used to generate stats (e.g. timestamp we take snapshots for feature values).", "format": "google-datetime", "type": "string" }, "score": { "description": "Feature importance score, only populated when cross-feature monitoring is enabled. For now only used to represent feature attribution score within range [0, 1] for ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_SKEW and ModelDeploymentMonitoringObjectiveType.FEATURE_ATTRIBUTION_DRIFT.", "type": "number", "format": "double" }, "startTime": { "type": "string", "description": "The start timestamp of window where stats were generated. For objectives where time window doesn't make sense (e.g. Featurestore Snapshot Monitoring), start_time is only used to indicate the monitoring intervals, so it always equals to (end_time - monitoring_interval).", "format": "google-datetime" }, "anomalyDetectionThreshold": { "description": "This is the threshold used when detecting anomalies. The threshold can be changed by user, so this one might be different from ThresholdConfig.value.", "type": "number", "format": "double" }, "statsUri": { "description": "Path of the stats file for current feature values in Cloud Storage bucket. Format: gs:////stats. Example: gs://monitoring_bucket/feature_name/stats. Stats are stored as binary format with Protobuf message [tensorflow.metadata.v0.FeatureNameStatistics](https://github.com/tensorflow/metadata/blob/master/tensorflow_metadata/proto/v0/statistics.proto).", "type": "string" } } }, "GoogleCloudAiplatformV1beta1ModelMonitoringStatsDataPointTypedValueDistributionDataValue": { "properties": { "distribution": { "description": "Predictive monitoring drift distribution in `tensorflow.metadata.v0.DatasetFeatureStatistics` format.", "type": "any" }, "distributionDeviation": { "type": "number", "format": "double", "description": "Distribution distance deviation from the current dataset's statistics to baseline dataset's statistics. * For categorical feature, the distribution distance is calculated by L-inifinity norm or Jensen–Shannon divergence. * For numerical feature, the distribution distance is calculated by Jensen–Shannon divergence." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ModelMonitoringStatsDataPointTypedValueDistributionDataValue", "description": "Summary statistics for a population of values." }, "GoogleCloudAiplatformV1beta1SchemaPredictParamsGroundingConfig": { "properties": { "disableAttribution": { "type": "boolean", "description": "If set, skip finding claim attributions (i.e not generate grounding citation).", "deprecated": true }, "sources": { "description": "The sources for the grounding checking.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaPredictParamsGroundingConfigSourceEntry" } } }, "id": "GoogleCloudAiplatformV1beta1SchemaPredictParamsGroundingConfig", "type": "object", "description": "The configuration for grounding checking." }, "GenaiVertexV1beta1CreateInteractionHttpRequest": { "id": "GenaiVertexV1beta1CreateInteractionHttpRequest", "properties": { "httpBody": { "$ref": "GoogleApiHttpBody", "description": "Required. The interaction to create." } }, "description": "Request message for [InteractionsService.CreateInteractionHttp].", "type": "object" }, "GoogleCloudAiplatformV1beta1NfsMount": { "description": "Represents a mount configuration for Network File System (NFS) to mount.", "type": "object", "properties": { "mountPoint": { "type": "string", "description": "Required. Destination mount path. The NFS will be mounted for the user under /mnt/nfs/" }, "server": { "description": "Required. IP address of the NFS server.", "type": "string" }, "path": { "type": "string", "description": "Required. Source path exported from NFS server. Has to start with '/', and combined with the ip address, it indicates the source mount path in the form of `server:path`" } }, "id": "GoogleCloudAiplatformV1beta1NfsMount" }, "GoogleCloudAiplatformV1beta1BatchImportEvaluatedAnnotationsResponse": { "description": "Response message for ModelService.BatchImportEvaluatedAnnotations", "properties": { "importedEvaluatedAnnotationsCount": { "type": "integer", "description": "Output only. Number of EvaluatedAnnotations imported.", "format": "int32", "readOnly": true } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1BatchImportEvaluatedAnnotationsResponse" }, "GoogleCloudAiplatformV1beta1SummarizationQualityInstance": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SummarizationQualityInstance", "description": "Spec for summarization quality instance.", "properties": { "context": { "description": "Required. Text to be summarized.", "type": "string" }, "reference": { "type": "string", "description": "Optional. Ground truth used to compare against the prediction." }, "prediction": { "description": "Required. Output of the evaluated model.", "type": "string" }, "instruction": { "type": "string", "description": "Required. Summarization prompt for LLM." } } }, "GenaiVertexV1beta1RetrievalResultDelta": { "description": "Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. ToolResultDelta.type", "properties": { "isError": { "type": "boolean", "description": "Whether the retrieval resulted in an error." } }, "type": "object", "id": "GenaiVertexV1beta1RetrievalResultDelta" }, "GoogleCloudAiplatformV1beta1ModelEvaluationModelEvaluationExplanationSpec": { "id": "GoogleCloudAiplatformV1beta1ModelEvaluationModelEvaluationExplanationSpec", "properties": { "explanationSpec": { "description": "Explanation spec details.", "$ref": "GoogleCloudAiplatformV1beta1ExplanationSpec" }, "explanationType": { "description": "Explanation type. For AutoML Image Classification models, possible values are: * `image-integrated-gradients` * `image-xrai`", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1CreateFeaturestoreOperationMetadata": { "type": "object", "id": "GoogleCloudAiplatformV1beta1CreateFeaturestoreOperationMetadata", "description": "Details of operations that perform create Featurestore.", "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "Operation metadata for Featurestore." } } }, "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteResponse": { "type": "object", "properties": { "writeResponses": { "items": { "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteResponseWriteResponse" }, "description": "Details about write for each key. If status is not OK, WriteResponse.data_key will have the key with error, but WriteResponse.online_store_write_time will not be present.", "type": "array" }, "status": { "$ref": "GoogleRpcStatus", "description": "Response status for the keys listed in FeatureViewDirectWriteResponse.write_responses. The error only applies to the listed data keys - the stream will remain open for further FeatureOnlineStoreService.FeatureViewDirectWriteRequest requests. Partial failures (e.g. if the first 10 keys of a request fail, but the rest succeed) from a single request may result in multiple responses - there will be one response for the successful request keys and one response for the failing request keys." } }, "description": "Response message for FeatureOnlineStoreService.FeatureViewDirectWrite.", "id": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteResponse" }, "GoogleCloudAiplatformV1beta1RagCorpusCorpusTypeConfigMemoryCorpus": { "description": "Config for the memory corpus.", "id": "GoogleCloudAiplatformV1beta1RagCorpusCorpusTypeConfigMemoryCorpus", "properties": { "llmParser": { "description": "The LLM parser to use for the memory corpus.", "$ref": "GoogleCloudAiplatformV1beta1RagFileParsingConfigLlmParser" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1UpsertExamplesRequest": { "properties": { "overwrite": { "description": "Optional. A flag indicating whether an example can be overwritten if it already exists. If False (default) and the example already exists, the example will not be updated. This does not affect behavior if the example does not exist already.", "type": "boolean" }, "examples": { "description": "Required. A list of examples to be created/updated.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Example" }, "type": "array" } }, "description": "Request message for ExampleStoreService.UpsertExamples.", "id": "GoogleCloudAiplatformV1beta1UpsertExamplesRequest", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaImageSegmentationAnnotation": { "id": "GoogleCloudAiplatformV1beta1SchemaImageSegmentationAnnotation", "type": "object", "properties": { "polygonAnnotation": { "$ref": "GoogleCloudAiplatformV1beta1SchemaImageSegmentationAnnotationPolygonAnnotation", "description": "Polygon annotation." }, "maskAnnotation": { "$ref": "GoogleCloudAiplatformV1beta1SchemaImageSegmentationAnnotationMaskAnnotation", "description": "Mask based segmentation annotation. Only one mask annotation can exist for one image." }, "polylineAnnotation": { "description": "Polyline annotation.", "$ref": "GoogleCloudAiplatformV1beta1SchemaImageSegmentationAnnotationPolylineAnnotation" } }, "description": "Annotation details specific to image segmentation." }, "GoogleCloudAiplatformV1beta1BatchDeleteRagDataSchemasRequest": { "id": "GoogleCloudAiplatformV1beta1BatchDeleteRagDataSchemasRequest", "type": "object", "description": "Request message for VertexRagDataService.BatchDeleteRagDataSchemas.", "properties": { "names": { "description": "Required. The RagDataSchemas to delete. A maximum of 500 schemas can be deleted in a batch. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}`", "items": { "type": "string" }, "type": "array" } } }, "GoogleCloudAiplatformV1beta1TaskStatusDetails": { "id": "GoogleCloudAiplatformV1beta1TaskStatusDetails", "type": "object", "description": "Represents the additional status details of a task.", "properties": { "taskMessage": { "$ref": "GoogleCloudAiplatformV1beta1TaskMessage", "description": "Optional. The message associated with the single-turn interaction between the user and the agent or agent and agent." } } }, "GoogleCloudAiplatformV1beta1ImportDataRequest": { "id": "GoogleCloudAiplatformV1beta1ImportDataRequest", "type": "object", "properties": { "importConfigs": { "items": { "$ref": "GoogleCloudAiplatformV1beta1ImportDataConfig" }, "type": "array", "description": "Required. The desired input locations. The contents of all input locations will be imported in one batch." } }, "description": "Request message for DatasetService.ImportData." }, "GoogleCloudAiplatformV1beta1ModelMonitoringStatsAnomalies": { "type": "object", "description": "Statistics and anomalies generated by Model Monitoring.", "id": "GoogleCloudAiplatformV1beta1ModelMonitoringStatsAnomalies", "properties": { "deployedModelId": { "type": "string", "description": "Deployed Model ID." }, "anomalyCount": { "description": "Number of anomalies within all stats.", "type": "integer", "format": "int32" }, "featureStats": { "type": "array", "description": "A list of historical Stats and Anomalies generated for all Features.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies" } }, "objective": { "description": "Model Monitoring Objective those stats and anomalies belonging to.", "enum": [ "MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_TYPE_UNSPECIFIED", "RAW_FEATURE_SKEW", "RAW_FEATURE_DRIFT", "FEATURE_ATTRIBUTION_SKEW", "FEATURE_ATTRIBUTION_DRIFT" ], "type": "string", "enumDescriptions": [ "Default value, should not be set.", "Raw feature values' stats to detect skew between Training-Prediction datasets.", "Raw feature values' stats to detect drift between Serving-Prediction datasets.", "Feature attribution scores to detect skew between Training-Prediction datasets.", "Feature attribution scores to detect skew between Prediction datasets collected within different time windows." ] } } }, "GoogleCloudAiplatformV1beta1BatchDedicatedResources": { "id": "GoogleCloudAiplatformV1beta1BatchDedicatedResources", "type": "object", "description": "A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration.", "properties": { "machineSpec": { "description": "Required. Immutable. The specification of a single machine.", "$ref": "GoogleCloudAiplatformV1beta1MachineSpec" }, "startingReplicaCount": { "type": "integer", "description": "Immutable. The number of machine replicas used at the start of the batch operation. If not set, Agent Platform decides starting number, not greater than max_replica_count", "format": "int32" }, "spot": { "type": "boolean", "description": "Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms)." }, "maxReplicaCount": { "format": "int32", "description": "Immutable. The maximum number of machine replicas the batch operation may be scaled to. The default value is 10.", "type": "integer" }, "flexStart": { "$ref": "GoogleCloudAiplatformV1beta1FlexStart", "description": "Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)" } } }, "GoogleCloudAiplatformV1beta1DisableMonitoredAgentRequest": { "description": "Request message for AgentAnomalyDetectionService.DisableMonitoredAgent.", "type": "object", "properties": {}, "id": "GoogleCloudAiplatformV1beta1DisableMonitoredAgentRequest" }, "GoogleCloudAiplatformV1beta1AudioTranscription": { "type": "object", "description": "The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate `Part` with its own `AudioTranscription` carrying the `speaker_label`.", "properties": { "words": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1AudioTranscriptionWordInfo" }, "description": "Optional. Detailed word-level transcriptions and timing details. Present when `word_timestamp` is set." }, "text": { "type": "string", "description": "Required. The transcription text of this audio segment." }, "speakerLabel": { "type": "string", "description": "Optional. A label identifying the speaker of this audio segment (e.g. `spk_1`, `spk_2`). Present when `diarization` is set." } }, "id": "GoogleCloudAiplatformV1beta1AudioTranscription" }, "GoogleCloudAiplatformV1beta1BatchCreateRagMetadataRequest": { "description": "Request message for VertexRagDataService.BatchCreateRagMetadata.", "properties": { "requests": { "items": { "$ref": "GoogleCloudAiplatformV1beta1CreateRagMetadataRequest" }, "type": "array", "description": "Required. The request messages for VertexRagDataService.CreateRagMetadata. A maximum of 500 rag file metadata can be created in a batch." } }, "id": "GoogleCloudAiplatformV1beta1BatchCreateRagMetadataRequest", "type": "object" }, "GoogleCloudAiplatformV1beta1MetricMetadata": { "type": "object", "id": "GoogleCloudAiplatformV1beta1MetricMetadata", "description": "Metadata about the metric, used for visualization and organization.", "properties": { "otherMetadata": { "type": "object", "description": "Optional. Flexible metadata for user-defined attributes.", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "scoreRange": { "$ref": "GoogleCloudAiplatformV1beta1MetricMetadataScoreRange", "description": "Optional. The range of possible scores for this metric, used for plotting." }, "title": { "description": "Optional. The user-friendly name for the metric. If not set for a registered metric, it will default to the metric's display name.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1PurgeArtifactsRequest": { "type": "object", "id": "GoogleCloudAiplatformV1beta1PurgeArtifactsRequest", "properties": { "force": { "type": "boolean", "description": "Optional. Flag to indicate to actually perform the purge. If `force` is set to false, the method will return a sample of Artifact names that would be deleted." }, "filter": { "description": "Required. A required filter matching the Artifacts to be purged. E.g., `update_time \u003c= 2020-11-19T11:30:00-04:00`.", "type": "string" } }, "description": "Request message for MetadataService.PurgeArtifacts." }, "GoogleCloudAiplatformV1beta1RougeResults": { "id": "GoogleCloudAiplatformV1beta1RougeResults", "description": "Results for rouge metric.", "type": "object", "properties": { "rougeMetricValues": { "items": { "$ref": "GoogleCloudAiplatformV1beta1RougeMetricValue" }, "description": "Output only. Rouge metric values.", "readOnly": true, "type": "array" } } }, "GoogleCloudAiplatformV1beta1ExportTensorboardTimeSeriesDataResponse": { "description": "Response message for TensorboardService.ExportTensorboardTimeSeriesData.", "id": "GoogleCloudAiplatformV1beta1ExportTensorboardTimeSeriesDataResponse", "properties": { "timeSeriesDataPoints": { "description": "The returned time series data points.", "items": { "$ref": "GoogleCloudAiplatformV1beta1TimeSeriesDataPoint" }, "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1DeployModelOperationMetadata": { "type": "object", "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "The operation generic information." }, "deploymentStage": { "readOnly": true, "enumDescriptions": [ "Default value. This value is unused.", "The deployment is initializing and setting up the environment.", "The deployment is preparing the model assets.", "The deployment is creating the underlying serving cluster.", "The deployment is adding nodes to the serving cluster.", "The deployment is getting the container image for the model server.", "The deployment is starting the model server.", "The deployment is performing finalization steps.", "The deployment has terminated.", "The deployment has succeeded.", "The deployment has failed." ], "enum": [ "DEPLOYMENT_STAGE_UNSPECIFIED", "STARTING_DEPLOYMENT", "PREPARING_MODEL", "CREATING_SERVING_CLUSTER", "ADDING_NODES_TO_CLUSTER", "GETTING_CONTAINER_IMAGE", "STARTING_MODEL_SERVER", "FINISHING_UP", "DEPLOYMENT_TERMINATED", "SUCCESSFULLY_DEPLOYED", "FAILED_TO_DEPLOY" ], "type": "string", "description": "Output only. The deployment stage of the model." } }, "id": "GoogleCloudAiplatformV1beta1DeployModelOperationMetadata", "description": "Runtime operation information for EndpointService.DeployModel." }, "GoogleCloudAiplatformV1beta1ExplanationParameters": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ExplanationParameters", "description": "Parameters to configure explaining for Model's predictions.", "properties": { "examples": { "$ref": "GoogleCloudAiplatformV1beta1Examples", "description": "Example-based explanations that returns the nearest neighbors from the provided dataset." }, "integratedGradientsAttribution": { "$ref": "GoogleCloudAiplatformV1beta1IntegratedGradientsAttribution", "description": "An attribution method that computes Aumann-Shapley values taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1703.01365" }, "topK": { "format": "int32", "type": "integer", "description": "If populated, returns attributions for top K indices of outputs (defaults to 1). Only applies to Models that predicts more than one outputs (e,g, multi-class Models). When set to -1, returns explanations for all outputs." }, "sampledShapleyAttribution": { "description": "An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features. Refer to this paper for model details: https://arxiv.org/abs/1306.4265.", "$ref": "GoogleCloudAiplatformV1beta1SampledShapleyAttribution" }, "outputIndices": { "description": "If populated, only returns attributions that have output_index contained in output_indices. It must be an ndarray of integers, with the same shape of the output it's explaining. If not populated, returns attributions for top_k indices of outputs. If neither top_k nor output_indices is populated, returns the argmax index of the outputs. Only applicable to Models that predict multiple outputs (e,g, multi-class Models that predict multiple classes).", "items": { "type": "any" }, "type": "array" }, "xraiAttribution": { "$ref": "GoogleCloudAiplatformV1beta1XraiAttribution", "description": "An attribution method that redistributes Integrated Gradients attribution to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 XRAI currently performs better on natural images, like a picture of a house or an animal. If the images are taken in artificial environments, like a lab or manufacturing line, or from diagnostic equipment, like x-rays or quality-control cameras, use Integrated Gradients instead." } } }, "GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsRequest": { "description": "Request message for ModelMonitoringService.SearchModelMonitoringStats.", "properties": { "pageSize": { "type": "integer", "description": "The standard list page size.", "format": "int32" }, "pageToken": { "description": "A page token received from a previous ModelMonitoringService.SearchModelMonitoringStats call.", "type": "string" }, "timeInterval": { "description": "The time interval for which results should be returned.", "$ref": "GoogleTypeInterval" }, "statsFilter": { "description": "Filter for search different stats.", "$ref": "GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsFilter" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsRequest" }, "GoogleCloudAiplatformV1beta1A2aTaskStatusUpdate": { "type": "object", "id": "GoogleCloudAiplatformV1beta1A2aTaskStatusUpdate", "properties": { "message": { "$ref": "GoogleCloudAiplatformV1beta1A2aTaskMessage", "description": "Optional. The status message associated with the state change." }, "timestamp": { "type": "string", "description": "Optional. The time at which the status change occurred.", "format": "google-datetime" }, "state": { "enumDescriptions": [ "The task is in an unknown or indeterminate state.", "Indicates that a task has been successfully submitted and acknowledged.", "Indicates that a task is actively being processed by the agent.", "Indicates that a task has finished successfully. This is a terminal state.", "Indicates that a task has finished with an error. This is a terminal state.", "Indicates that a task was canceled before completion. This is a terminal state.", "Indicates that the agent requires additional user input to proceed. This is an interrupted state.", "Indicates that the agent has decided to not perform the task. This may be done during initial task creation or later once an agent has determined it can't or won't proceed. This is a terminal state.", "Indicates that authentication is required to proceed. This is an interrupted state." ], "type": "string", "description": "Required. The new state of the task.", "enum": [ "STATE_UNSPECIFIED", "TASK_STATE_SUBMITTED", "TASK_STATE_WORKING", "TASK_STATE_COMPLETED", "TASK_STATE_FAILED", "TASK_STATE_CANCELED", "TASK_STATE_INPUT_REQUIRED", "TASK_STATE_REJECTED", "TASK_STATE_AUTH_REQUIRED" ] } }, "description": "An event payload that updates the task's state and optional status message." }, "GoogleCloudAiplatformV1beta1ListSchedulesResponse": { "id": "GoogleCloudAiplatformV1beta1ListSchedulesResponse", "description": "Response message for ScheduleService.ListSchedules", "properties": { "nextPageToken": { "description": "A token to retrieve the next page of results. Pass to ListSchedulesRequest.page_token to obtain that page.", "type": "string" }, "schedules": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Schedule" }, "description": "List of Schedules in the requested page.", "type": "array" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1OutputConfig": { "id": "GoogleCloudAiplatformV1beta1OutputConfig", "type": "object", "description": "Config for evaluation output.", "properties": { "gcsDestination": { "description": "Cloud storage destination for evaluation output.", "$ref": "GoogleCloudAiplatformV1beta1GcsDestination" } } }, "GoogleCloudAiplatformV1beta1QuestionAnsweringQualityInput": { "type": "object", "description": "Input for question answering quality metric.", "id": "GoogleCloudAiplatformV1beta1QuestionAnsweringQualityInput", "properties": { "metricSpec": { "description": "Required. Spec for question answering quality score metric.", "$ref": "GoogleCloudAiplatformV1beta1QuestionAnsweringQualitySpec" }, "instance": { "$ref": "GoogleCloudAiplatformV1beta1QuestionAnsweringQualityInstance", "description": "Required. Question answering quality instance." } } }, "GoogleCloudAiplatformV1beta1IngestEventsRequest": { "description": "Request message for MemoryBankService.IngestEvents.", "id": "GoogleCloudAiplatformV1beta1IngestEventsRequest", "type": "object", "properties": { "revisionTtl": { "type": "string", "description": "Optional. The TTL for the revision. The expiration time is computed: now + TTL.", "format": "google-duration" }, "streamId": { "description": "Optional. The ID of the stream to ingest events into. If not provided, a new one will be created.", "type": "string" }, "scope": { "type": "object", "description": "Required. The scope of the memories that should be generated from the stream. Memories will be consolidated across memories with the same scope. Scope values cannot contain the wildcard character '*'.", "additionalProperties": { "type": "string" } }, "forceFlush": { "description": "Optional. Forces a flush of all pending events in the stream and triggers memory generation immediately bypassing any conditions configured in the `generation_trigger_config`.", "type": "boolean" }, "disableMemoryRevisions": { "type": "boolean", "description": "Optional. If true, no revisions will be created for this request." }, "metadataMergeStrategy": { "enumDescriptions": [ "Unspecified metadata merge strategy. If unspecified, the default behavior is to overwrite existing metadata (`OVERWRITE`).", "Replace the metadata of the updated memories with the new metadata.", "Append new metadata to the existing metadata. If there are duplicate keys, the existing values will be overwritten.", "Restrict consolidation to memories that have exactly the same metadata as the request. If a memory doesn't have the same metadata, it is not eligible for consolidation." ], "description": "Optional. The strategy to use when applying metadata to existing memories.", "enum": [ "METADATA_MERGE_STRATEGY_UNSPECIFIED", "OVERWRITE", "MERGE", "REQUIRE_EXACT_MATCH" ], "type": "string" }, "generationTriggerConfig": { "description": "Optional. Configuration for triggering memory generation from this ingestion. If not set, then the stream will be force flushed immediately.", "$ref": "GoogleCloudAiplatformV1beta1MemoryGenerationTriggerConfig" }, "revisionExpireTime": { "format": "google-datetime", "description": "Optional. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.", "type": "string" }, "metadata": { "description": "Optional. User-provided metadata for the generated memories. This is not generated by Memory Bank.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1MemoryMetadataValue" } }, "revisionLabels": { "description": "Optional. Labels to be applied to the generated memory revisions. For example, you can use this to label a revision with its data source.", "additionalProperties": { "type": "string" }, "type": "object" }, "directContentsSource": { "description": "Ingest events directly from the request.", "$ref": "GoogleCloudAiplatformV1beta1IngestionDirectContentsSource" } } }, "GoogleCloudAiplatformV1beta1CancelNasJobRequest": { "type": "object", "id": "GoogleCloudAiplatformV1beta1CancelNasJobRequest", "description": "Request message for JobService.CancelNasJob.", "properties": {} }, "GoogleCloudAiplatformV1beta1FeatureValueDestination": { "type": "object", "properties": { "tfrecordDestination": { "$ref": "GoogleCloudAiplatformV1beta1TFRecordDestination", "description": "Output in TFRecord format. Below are the mapping from Feature value type in Featurestore to Feature value type in TFRecord: Value type in Featurestore | Value type in TFRecord DOUBLE, DOUBLE_ARRAY | FLOAT_LIST INT64, INT64_ARRAY | INT64_LIST STRING, STRING_ARRAY, BYTES | BYTES_LIST true -\u003e byte_string(\"true\"), false -\u003e byte_string(\"false\") BOOL, BOOL_ARRAY (true, false) | BYTES_LIST" }, "csvDestination": { "$ref": "GoogleCloudAiplatformV1beta1CsvDestination", "description": "Output in CSV format. Array Feature value types are not allowed in CSV format." }, "bigqueryDestination": { "description": "Output in BigQuery format. BigQueryDestination.output_uri in FeatureValueDestination.bigquery_destination must refer to a table.", "$ref": "GoogleCloudAiplatformV1beta1BigQueryDestination" } }, "id": "GoogleCloudAiplatformV1beta1FeatureValueDestination", "description": "A destination location for Feature values and format." }, "GoogleCloudAiplatformV1beta1ResumeModelDeploymentMonitoringJobRequest": { "description": "Request message for JobService.ResumeModelDeploymentMonitoringJob.", "id": "GoogleCloudAiplatformV1beta1ResumeModelDeploymentMonitoringJobRequest", "properties": {}, "type": "object" }, "GoogleCloudAiplatformV1beta1FeatureOnlineStoreDedicatedServingEndpoint": { "id": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreDedicatedServingEndpoint", "properties": { "publicEndpointDomainName": { "description": "Output only. This field will be populated with the domain name to use for this FeatureOnlineStore", "type": "string", "readOnly": true }, "privateServiceConnectConfig": { "description": "Optional. Private service connect config. The private service connection is available only for Optimized storage type, not for embedding management now. If PrivateServiceConnectConfig.enable_private_service_connect set to true, customers will use private service connection to send request. Otherwise, the connection will set to public endpoint.", "$ref": "GoogleCloudAiplatformV1beta1PrivateServiceConnectConfig" }, "serviceAttachment": { "description": "Output only. The name of the service attachment resource. Populated if private service connect is enabled and after FeatureViewSync is created.", "readOnly": true, "type": "string" } }, "description": "The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default.", "type": "object" }, "GoogleCloudAiplatformV1beta1ToolParameterKVMatchSpec": { "description": "Spec for tool parameter key value match metric.", "type": "object", "id": "GoogleCloudAiplatformV1beta1ToolParameterKVMatchSpec", "properties": { "useStrictStringMatch": { "description": "Optional. Whether to use STRICT string match on parameter values.", "type": "boolean" } } }, "GoogleCloudAiplatformV1beta1RetrieveMemoriesResponse": { "id": "GoogleCloudAiplatformV1beta1RetrieveMemoriesResponse", "description": "Response message for MemoryBankService.RetrieveMemories.", "properties": { "retrievedMemories": { "items": { "$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesResponseRetrievedMemory" }, "description": "The retrieved memories.", "type": "array" }, "nextPageToken": { "type": "string", "description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. This token is not set if similarity search was used for retrieval." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ToolComputerUse": { "id": "GoogleCloudAiplatformV1beta1ToolComputerUse", "properties": { "excludedPredefinedFunctions": { "description": "Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.", "type": "array", "items": { "type": "string" } }, "environment": { "description": "Required. The environment being operated.", "enumDescriptions": [ "Defaults to browser.", "Operates in a web browser.", "Operates in a mobile environment.", "Operates in a desktop environment." ], "type": "string", "enum": [ "ENVIRONMENT_UNSPECIFIED", "ENVIRONMENT_BROWSER", "ENVIRONMENT_MOBILE", "ENVIRONMENT_DESKTOP" ] }, "enablePromptInjectionDetection": { "type": "boolean", "description": "Optional. Enables the prompt injection detection check on computer-use request." } }, "description": "Tool to support computer use.", "type": "object" }, "GoogleCloudAiplatformV1beta1ProbeExecAction": { "type": "object", "description": "ExecAction specifies a command to execute.", "properties": { "command": { "items": { "type": "string" }, "description": "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.", "type": "array" } }, "id": "GoogleCloudAiplatformV1beta1ProbeExecAction" }, "GoogleCloudAiplatformV1beta1StopTrialRequest": { "type": "object", "properties": {}, "description": "Request message for VizierService.StopTrial.", "id": "GoogleCloudAiplatformV1beta1StopTrialRequest" }, "GoogleCloudAiplatformV1beta1NasJobOutputMultiTrialJobOutput": { "properties": { "searchTrials": { "items": { "$ref": "GoogleCloudAiplatformV1beta1NasTrial" }, "type": "array", "readOnly": true, "description": "Output only. List of NasTrials that were started as part of search stage." }, "trainTrials": { "items": { "$ref": "GoogleCloudAiplatformV1beta1NasTrial" }, "readOnly": true, "type": "array", "description": "Output only. List of NasTrials that were started as part of train stage." } }, "type": "object", "description": "The output of a multi-trial Neural Architecture Search (NAS) jobs.", "id": "GoogleCloudAiplatformV1beta1NasJobOutputMultiTrialJobOutput" }, "GoogleCloudAiplatformV1beta1SharePointSources": { "id": "GoogleCloudAiplatformV1beta1SharePointSources", "description": "The SharePointSources to pass to ImportRagFiles.", "type": "object", "properties": { "sharePointSources": { "items": { "$ref": "GoogleCloudAiplatformV1beta1SharePointSourcesSharePointSource" }, "description": "The SharePoint sources.", "type": "array" } } }, "GoogleCloudAiplatformV1beta1PointwiseMetricInstance": { "id": "GoogleCloudAiplatformV1beta1PointwiseMetricInstance", "type": "object", "description": "Pointwise metric instance. Usually one instance corresponds to one row in an evaluation dataset.", "properties": { "contentMapInstance": { "description": "Key-value contents for the mutlimodality input, including text, image, video, audio, and pdf, etc. The key is placeholder in metric prompt template, and the value is the multimodal content.", "$ref": "GoogleCloudAiplatformV1beta1ContentMap" }, "jsonInstance": { "type": "string", "description": "Instance specified as a json string. String key-value pairs are expected in the json_instance to render PointwiseMetricSpec.instance_prompt_template." } } }, "GoogleCloudAiplatformV1beta1Part": { "id": "GoogleCloudAiplatformV1beta1Part", "properties": { "videoMetadata": { "$ref": "GoogleCloudAiplatformV1beta1VideoMetadata", "description": "Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data." }, "audioTranscription": { "$ref": "GoogleCloudAiplatformV1beta1AudioTranscription", "description": "Optional. Audio (input or output) transcription. This is only set when this `Part` contains audio data." }, "functionResponse": { "$ref": "GoogleCloudAiplatformV1beta1FunctionResponse", "description": "Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted." }, "thoughtSignature": { "description": "Optional. An opaque signature for the thought so it can be reused in subsequent requests.", "type": "string", "format": "byte" }, "inlineData": { "$ref": "GoogleCloudAiplatformV1beta1Blob", "description": "Optional. The inline data content of the part. This can be used to include images, audio, or video in a request." }, "mediaProcessing": { "enumDescriptions": [ "Defaults to model-specific processing.", "Fixed-rate frame extraction. All frames placed in context.", "Model-driven dynamic navigation. Recommended for most use cases." ], "description": "Optional. How the model processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field.", "enum": [ "MEDIA_PROCESSING_UNSPECIFIED", "STATIC", "AGENTIC" ], "type": "string" }, "mediaResolution": { "$ref": "GoogleCloudAiplatformV1beta1PartMediaResolution", "description": "per part media resolution. Media resolution for the input media." }, "fileData": { "$ref": "GoogleCloudAiplatformV1beta1FileData", "description": "Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage." }, "executableCode": { "description": "Optional. Code generated by the model that is intended to be executed.", "$ref": "GoogleCloudAiplatformV1beta1ExecutableCode" }, "codeExecutionResult": { "description": "Optional. The result of executing the ExecutableCode.", "$ref": "GoogleCloudAiplatformV1beta1CodeExecutionResult" }, "thought": { "type": "boolean", "description": "Optional. Indicates whether the `part` represents the model's thought process or reasoning." }, "text": { "type": "string", "description": "Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent." }, "functionCall": { "description": "Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.", "$ref": "GoogleCloudAiplatformV1beta1FunctionCall" } }, "type": "object", "description": "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`. For media types that are not text, `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." }, "GoogleCloudAiplatformV1beta1TaskEvent": { "description": "An event that occurred for a task. Note that TaskEvent is just a record of task's change. Hence, it's not a Cloud resource.", "id": "GoogleCloudAiplatformV1beta1TaskEvent", "properties": { "createTime": { "readOnly": true, "type": "string", "description": "Output only. The create time of the event.", "format": "google-datetime" }, "eventData": { "description": "Required. The delta associated with the event.", "$ref": "GoogleCloudAiplatformV1beta1TaskEventData" }, "eventSequenceNumber": { "description": "Required. The sequence number of the event. This is used to uniquely identify the event within the task and order events chronologically. This is a id generated by the SDK.", "format": "int64", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1StudySpecParameterSpecDiscreteValueSpec": { "description": "Value specification for a parameter in `DISCRETE` type.", "properties": { "values": { "description": "Required. A list of possible values. The list should be in increasing order and at least 1e-10 apart. For instance, this parameter might have possible settings of 1.5, 2.5, and 4.0. This list should not contain more than 1,000 values.", "type": "array", "items": { "format": "double", "type": "number" } }, "defaultValue": { "format": "double", "type": "number", "description": "A default value for a `DISCRETE` parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. It automatically rounds to the nearest feasible discrete point. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1StudySpecParameterSpecDiscreteValueSpec" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation": { "properties": { "columnName": { "type": "string" }, "timeFormat": { "description": "The format in which that time field is expressed. The time_format must either be one of: * `unix-seconds` * `unix-milliseconds` * `unix-microseconds` * `unix-nanoseconds` (for respectively number of seconds, milliseconds, microseconds and nanoseconds since start of the Unix epoch); or be written in `strftime` syntax. If time_format is not set, then the default format is RFC 3339 `date-time` format, where `time-offset` = `\"Z\"` (e.g. 1985-04-12T23:20:50.52Z)", "type": "string" } }, "description": "Training pipeline will perform following transformation functions. * Apply the transformation functions for Numerical columns. * Determine the year, month, day,and weekday. Treat each value from the timestamp as a Categorical column. * Invalid numerical values (for example, values that fall outside of a typical timestamp range, or are extreme values) receive no special treatment and are not removed.", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation", "type": "object" }, "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityOpenTelemetry": { "id": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityOpenTelemetry", "type": "object", "description": "Configuration for data source following OpenTelemetry.", "properties": { "semconvVersion": { "type": "string", "description": "Required. Defines which version OTel Semantic Convention the data follows. Can be \"1.39.0\" or newer." } } }, "GoogleCloudAiplatformV1beta1ContentsExample": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ContentsExample", "properties": { "expectedContents": { "description": "Required. The expected output for the given `contents`. To represent multi-step reasoning, this is a repeated field that contains the iterative steps of the expected output.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ContentsExampleExpectedContent" }, "type": "array" }, "contents": { "description": "Required. The content of the conversation with the model that resulted in the expected output.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" } } }, "description": "A single example of a conversation with the model." }, "GoogleCloudAiplatformV1beta1RemoveContextChildrenResponse": { "description": "Response message for MetadataService.RemoveContextChildren.", "id": "GoogleCloudAiplatformV1beta1RemoveContextChildrenResponse", "type": "object", "properties": {} }, "GoogleCloudAiplatformV1beta1SchemaPromptSpecTranslationPrompt": { "properties": { "sourceLanguageCode": { "type": "string", "description": "The source language code." }, "option": { "description": "The translation option.", "$ref": "GoogleCloudAiplatformV1beta1SchemaPromptSpecTranslationOption" }, "promptMessage": { "$ref": "GoogleCloudAiplatformV1beta1SchemaPromptSpecPromptMessage", "description": "The prompt message." }, "example": { "description": "The translation example.", "$ref": "GoogleCloudAiplatformV1beta1SchemaPromptSpecTranslationExample" }, "targetLanguageCode": { "type": "string", "description": "The target language code." } }, "id": "GoogleCloudAiplatformV1beta1SchemaPromptSpecTranslationPrompt", "type": "object", "description": "Prompt variation for Translation use case." }, "GenaiVertexV1beta1RetrievalResultStep": { "description": "Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc.", "type": "object", "properties": { "isError": { "description": "Whether the retrieval resulted in an error.", "type": "boolean" } }, "id": "GenaiVertexV1beta1RetrievalResultStep" }, "GoogleCloudAiplatformV1beta1ModelMonitoringInputModelMonitoringDatasetModelMonitoringBigQuerySource": { "id": "GoogleCloudAiplatformV1beta1ModelMonitoringInputModelMonitoringDatasetModelMonitoringBigQuerySource", "description": "Dataset spec for data sotred in BigQuery.", "type": "object", "properties": { "tableUri": { "description": "BigQuery URI to a table, up to 2000 characters long. All the columns in the table will be selected. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.", "type": "string" }, "query": { "description": "Standard SQL to be used instead of the `table_uri`.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1ListRagCorporaResponse": { "id": "GoogleCloudAiplatformV1beta1ListRagCorporaResponse", "description": "Response message for VertexRagDataService.ListRagCorpora.", "type": "object", "properties": { "ragCorpora": { "items": { "$ref": "GoogleCloudAiplatformV1beta1RagCorpus" }, "description": "List of RagCorpora in the requested page.", "type": "array" }, "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results. Pass to ListRagCorporaRequest.page_token to obtain that page." } } }, "GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpecAgentGatewayConfig": { "description": "Agent Gateway configuration for a Reasoning Engine deployment.", "properties": { "clientToAgentConfig": { "description": "Optional. Configuration for traffic targeting the Reasoning Engine. When unset, incoming traffic is not routed through an Agent Gateway.", "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigClientToAgentConfig" }, "agentToAnywhereConfig": { "description": "Optional. Configuration for traffic originating from the Reasoning Engine. When unset, outgoing traffic is not routed through an Agent Gateway.", "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigAgentToAnywhereConfig" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpecAgentGatewayConfig" }, "GoogleCloudAiplatformV1beta1TensorboardBlobSequence": { "id": "GoogleCloudAiplatformV1beta1TensorboardBlobSequence", "description": "One point viewable on a blob metric plot, but mostly just a wrapper message to work around repeated fields can't be used directly within `oneof` fields.", "properties": { "values": { "description": "List of blobs contained within the sequence.", "items": { "$ref": "GoogleCloudAiplatformV1beta1TensorboardBlob" }, "type": "array" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1FeatureGroupBigQueryTimeSeries": { "id": "GoogleCloudAiplatformV1beta1FeatureGroupBigQueryTimeSeries", "properties": { "timestampColumn": { "type": "string", "description": "Optional. Column hosting timestamp values for a time-series source. Will be used to determine the latest `feature_values` for each entity. Optional. If not provided, column named `feature_timestamp` of type `TIMESTAMP` will be used." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1RagFileChunkingConfigFixedLengthChunking": { "properties": { "chunkSize": { "format": "int32", "description": "The size of the chunks.", "type": "integer" }, "chunkOverlap": { "format": "int32", "description": "The overlap between chunks.", "type": "integer" } }, "description": "Specifies the fixed length chunking config.", "type": "object", "id": "GoogleCloudAiplatformV1beta1RagFileChunkingConfigFixedLengthChunking" }, "GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadataContentValidationStats": { "type": "object", "id": "GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadataContentValidationStats", "properties": { "partialErrors": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadataRecordError" }, "description": "The detail information of the partial failures encountered for those invalid records that couldn't be parsed. Up to 50 partial errors will be reported." }, "invalidRecordCount": { "type": "string", "description": "Number of records in this file we skipped due to validate errors.", "format": "int64" }, "sourceGcsUri": { "type": "string", "description": "Cloud Storage URI pointing to the original file in user's bucket." }, "validSparseRecordCount": { "description": "Number of sparse records in this file that were successfully processed.", "format": "int64", "type": "string" }, "invalidSparseRecordCount": { "description": "Number of sparse records in this file we skipped due to validate errors.", "format": "int64", "type": "string" }, "validRecordCount": { "format": "int64", "type": "string", "description": "Number of records in this file that were successfully processed." } } }, "GoogleCloudAiplatformV1beta1ExplanationSpecOverride": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ExplanationSpecOverride", "description": "The ExplanationSpec entries that can be overridden at online explanation time.", "properties": { "metadata": { "description": "The metadata to be overridden. If not specified, no metadata is overridden.", "$ref": "GoogleCloudAiplatformV1beta1ExplanationMetadataOverride" }, "parameters": { "$ref": "GoogleCloudAiplatformV1beta1ExplanationParameters", "description": "The parameters to be overridden. Note that the attribution method cannot be changed. If not specified, no parameter is overridden." }, "examplesOverride": { "$ref": "GoogleCloudAiplatformV1beta1ExamplesOverride", "description": "The example-based explanations parameter overrides." } } }, "GoogleCloudAiplatformV1beta1PointwiseMetricInput": { "type": "object", "id": "GoogleCloudAiplatformV1beta1PointwiseMetricInput", "properties": { "metricSpec": { "description": "Required. Spec for pointwise metric.", "$ref": "GoogleCloudAiplatformV1beta1PointwiseMetricSpec" }, "instance": { "description": "Required. Pointwise metric instance.", "$ref": "GoogleCloudAiplatformV1beta1PointwiseMetricInstance" } }, "description": "Input for pointwise metric." }, "GoogleCloudAiplatformV1beta1SchemaTextClassificationAnnotation": { "description": "Annotation details specific to text classification.", "id": "GoogleCloudAiplatformV1beta1SchemaTextClassificationAnnotation", "properties": { "annotationSpecId": { "type": "string", "description": "The resource Id of the AnnotationSpec that this Annotation pertains to." }, "displayName": { "description": "The display name of the AnnotationSpec that this Annotation pertains to.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1SummaryMetrics": { "id": "GoogleCloudAiplatformV1beta1SummaryMetrics", "type": "object", "properties": { "totalItems": { "type": "integer", "description": "Optional. The total number of items that were evaluated.", "format": "int32" }, "failedItems": { "description": "Optional. The number of items that failed to be evaluated.", "format": "int32", "type": "integer" }, "metrics": { "description": "Optional. Map of metric name to metric value.", "additionalProperties": { "type": "any" }, "type": "object" } }, "description": "The summary metrics for the evaluation run." }, "GoogleCloudAiplatformV1beta1TokensInfo": { "description": "Tokens info with a list of tokens and the corresponding list of token ids.", "properties": { "tokens": { "description": "A list of tokens from the input.", "items": { "format": "byte", "type": "string" }, "type": "array" }, "role": { "type": "string", "description": "Optional. Optional fields for the role from the corresponding Content." }, "tokenIds": { "description": "A list of token ids from the input.", "items": { "format": "int64", "type": "string" }, "type": "array" } }, "id": "GoogleCloudAiplatformV1beta1TokensInfo", "type": "object" }, "GoogleCloudAiplatformV1beta1CreateIndexEndpointOperationMetadata": { "type": "object", "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "The operation generic information." } }, "description": "Runtime operation information for IndexEndpointService.CreateIndexEndpoint.", "id": "GoogleCloudAiplatformV1beta1CreateIndexEndpointOperationMetadata" }, "GoogleCloudAiplatformV1beta1RetrieveSkillsResponse": { "id": "GoogleCloudAiplatformV1beta1RetrieveSkillsResponse", "type": "object", "description": "Response message for SkillRegistryService.RetrieveSkills.", "properties": { "retrievedSkills": { "items": { "$ref": "GoogleCloudAiplatformV1beta1RetrieveSkillsResponseRetrievedSkill" }, "type": "array", "description": "Skills ranked by similarity if applicable; otherwise, the order is undefined." } } }, "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentDataConversationTurn": { "id": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentDataConversationTurn", "description": "Represents a single turn/invocation in the conversation.", "type": "object", "properties": { "events": { "description": "Optional. The list of events that occurred during this turn.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentDataAgentEvent" } }, "turnId": { "description": "Optional. A unique identifier for the turn. Useful for referencing specific turns across systems.", "type": "string" }, "turnIndex": { "type": "integer", "format": "int32", "description": "Required. The 0-based index of the turn in the conversation sequence." } } }, "GoogleCloudAiplatformV1beta1ReasoningEngineSpecContainerSpec": { "description": "Specification for deploying from a container image.", "properties": { "imageUri": { "type": "string", "description": "Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica." }, "port": { "type": "integer", "description": "Optional. The port the container listens on. Defaults to 8080 if unset.", "format": "int32" } }, "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecContainerSpec", "type": "object" }, "GoogleCloudAiplatformV1beta1ReinforcementTuningParseResponseConfig": { "description": "Defines how to parse sample response config for reinforcement tuning. The parsed response (i.e., substring) will be passed to the reward functions. For example, the input prompt might be: \u003e \"Perform step-by-step thoughts first to problem A, finally output answer in the \u003cans\u003e \u003c/ans\u003e block.\" The sample response from the model under tuning might look like: \u003e \"\u003cans\u003eYes\u003c/ans\u003e\" Here, users can define the following parse config: ``` { \"parseType\": \"REGEX_EXTRACT\", \"regexExtractExpression\": \".*(.*?)\" } ``` The resulting parsed response would be `\"Yes\"` and will be passed to the reward functions for evaluating rewards.", "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningParseResponseConfig", "type": "object", "properties": { "regexExtractExpression": { "type": "string", "description": "Defines the regex for extracting the important part of sample response. This field is only used when parse_type is ResponseParseType.REGEX_EXTRACT." }, "parseType": { "description": "Defines the type for parsing sample response.", "enumDescriptions": [ "Default value. Fallback to IDENTITY", "Returns the sample response as is.", "Uses regex to extract the important part of sample response. Similar to [GoogleSQL](https://cloud.google.com/bigquery/docs/reference/standard-sql/string_functions#regexp_extract) `REGEX_EXTRACT(response, regex_extract_expression)`, but different in that if there are multiple matches, the last match will be returned." ], "enum": [ "RESPONSE_PARSE_TYPE_UNSPECIFIED", "IDENTITY", "REGEX_EXTRACT" ], "type": "string" } } }, "GoogleCloudAiplatformV1beta1SchemaPromptSpecTranslationExample": { "properties": { "referenceSentencesFileInputs": { "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaPromptSpecTranslationSentenceFileInput" }, "description": "The reference sentences from file.", "type": "array" }, "referenceSentencePairLists": { "type": "array", "description": "The reference sentences from inline text.", "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaPromptSpecReferenceSentencePairList" } } }, "id": "GoogleCloudAiplatformV1beta1SchemaPromptSpecTranslationExample", "type": "object", "description": "The translation example that contains reference sentences from various sources." }, "GoogleCloudAiplatformV1beta1IndexDatapoint": { "type": "object", "id": "GoogleCloudAiplatformV1beta1IndexDatapoint", "description": "A datapoint of Index.", "properties": { "crowdingTag": { "$ref": "GoogleCloudAiplatformV1beta1IndexDatapointCrowdingTag", "description": "Optional. CrowdingTag of the datapoint, the number of neighbors to return in each crowding can be configured during query." }, "featureVector": { "description": "Required. Feature embedding vector for dense index. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions].", "items": { "type": "number", "format": "float" }, "type": "array" }, "restricts": { "items": { "$ref": "GoogleCloudAiplatformV1beta1IndexDatapointRestriction" }, "type": "array", "description": "Optional. List of Restrict of the datapoint, used to perform \"restricted searches\" where boolean rule are used to filter the subset of the database eligible for matching. This uses categorical tokens. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering" }, "sparseEmbedding": { "$ref": "GoogleCloudAiplatformV1beta1IndexDatapointSparseEmbedding", "description": "Optional. Feature embedding vector for sparse index." }, "datapointId": { "type": "string", "description": "Required. Unique identifier of the datapoint." }, "numericRestricts": { "description": "Optional. List of Restrict of the datapoint, used to perform \"restricted searches\" where boolean rule are used to filter the subset of the database eligible for matching. This uses numeric comparisons.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1IndexDatapointNumericRestriction" } }, "embeddingMetadata": { "type": "object", "description": "Optional. The key-value map of additional metadata for the datapoint.", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "GoogleCloudAiplatformV1beta1DedicatedResources": { "id": "GoogleCloudAiplatformV1beta1DedicatedResources", "type": "object", "description": "A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration.", "properties": { "maxReplicaCount": { "format": "int32", "type": "integer", "description": "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 Agent Platform 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)." }, "initialReplicaCount": { "type": "integer", "description": "Immutable. Number of initial replicas being deployed on when scaling the workload up from zero or when creating the workload in case min_replica_count = 0. When min_replica_count \u003e 0 (meaning that the scale-to-zero feature is not enabled), initial_replica_count should not be set. When min_replica_count = 0 (meaning that the scale-to-zero feature is enabled), initial_replica_count should be larger than zero, but no greater than max_replica_count.", "format": "int32" }, "spot": { "type": "boolean", "description": "Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms)." }, "minReplicaCount": { "format": "int32", "description": "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.", "type": "integer" }, "autoscalingMetricSpecs": { "description": "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`.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1AutoscalingMetricSpec" } }, "requiredReplicaCount": { "description": "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.", "format": "int32", "type": "integer" }, "machineSpec": { "description": "Required. Immutable. The specification of a single machine being used.", "$ref": "GoogleCloudAiplatformV1beta1MachineSpec" }, "scaleToZeroSpec": { "description": "Optional. Specification for scale-to-zero feature.", "$ref": "GoogleCloudAiplatformV1beta1DedicatedResourcesScaleToZeroSpec" }, "flexStart": { "$ref": "GoogleCloudAiplatformV1beta1FlexStart", "description": "Optional. Immutable. If set, use DWS resource to schedule the deployment workload. reference: (https://cloud.google.com/blog/products/compute/introducing-dynamic-workload-scheduler)" } } }, "GoogleCloudAiplatformV1beta1RagMetadataSchemaDetailsSearchStrategy": { "id": "GoogleCloudAiplatformV1beta1RagMetadataSchemaDetailsSearchStrategy", "description": "The search strategy for the metadata value of the `key`.", "type": "object", "properties": { "searchStrategyType": { "type": "string", "description": "The search strategy type to be applied on the metadata key.", "enum": [ "SEARCH_STRATEGY_TYPE_UNSPECIFIED", "NO_SEARCH", "EXACT_SEARCH" ], "enumDescriptions": [ "Unspecified search strategy type.", "metadata values of the `key` above will not be searchable.", "When searching with `key`, the value must be exactly as the metadata value that has been ingested." ] } } }, "GoogleCloudAiplatformV1beta1SchemaPredictPredictionTextExtractionPredictionResult": { "id": "GoogleCloudAiplatformV1beta1SchemaPredictPredictionTextExtractionPredictionResult", "description": "Prediction output format for Text Extraction.", "properties": { "displayNames": { "items": { "type": "string" }, "description": "The display names of the AnnotationSpecs that had been identified, order matches the IDs.", "type": "array" }, "textSegmentEndOffsets": { "type": "array", "items": { "format": "int64", "type": "string" }, "description": "The end offsets, inclusive, of the text segment in which the AnnotationSpec has been identified. Expressed as a zero-based number of characters as measured from the start of the text snippet." }, "textSegmentStartOffsets": { "items": { "type": "string", "format": "int64" }, "description": "The start offsets, inclusive, of the text segment in which the AnnotationSpec has been identified. Expressed as a zero-based number of characters as measured from the start of the text snippet.", "type": "array" }, "confidences": { "description": "The Model's confidences in correctness of the predicted IDs, higher value means higher confidence. Order matches the Ids.", "items": { "format": "float", "type": "number" }, "type": "array" }, "ids": { "items": { "type": "string", "format": "int64" }, "description": "The resource IDs of the AnnotationSpecs that had been identified, ordered by the confidence score descendingly.", "type": "array" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1DeleteFeatureValuesResponseSelectEntity": { "id": "GoogleCloudAiplatformV1beta1DeleteFeatureValuesResponseSelectEntity", "description": "Response message if the request uses the SelectEntity option.", "type": "object", "properties": { "offlineStorageDeletedEntityRowCount": { "format": "int64", "description": "The count of deleted entity rows in the offline storage. Each row corresponds to the combination of an entity ID and a timestamp. One entity ID can have multiple rows in the offline storage.", "type": "string" }, "onlineStorageDeletedEntityCount": { "description": "The count of deleted entities in the online storage. Each entity ID corresponds to one entity.", "format": "int64", "type": "string" } } }, "GoogleCloudAiplatformV1beta1AsyncQueryReasoningEngineRequest": { "properties": { "inputGcsUri": { "description": "Optional. Input Cloud Storage URI for the Async query. If you are not bringing your own container (BYOC), the content of the file should be a JSON object with an `input` field matching the `input` field of `QueryReasoningEngineRequest` (e.g. `{ \"input\": { \"user_id\": \"hello\", \"message\":\"$QUERY\"} }`). For BYOC, the content of the file depends on the the agent application.", "type": "string" }, "outputGcsUri": { "type": "string", "description": "Optional. Output Cloud Storage URI for the Async query. This contains the final response of the query." } }, "description": "Request message for ReasoningEngineExecutionService.AsyncQueryReasoningEngine.", "type": "object", "id": "GoogleCloudAiplatformV1beta1AsyncQueryReasoningEngineRequest" }, "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigAgentRunConfig": { "type": "object", "id": "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigAgentRunConfig", "description": "Configuration for Agent Run.", "properties": { "sessionInput": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigSessionInput", "description": "Optional. The session input to get agent running results." }, "userSimulatorConfig": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigAgentRunConfigUserSimulatorConfig", "description": "The configuration for a user simulator that uses an LLM to generate messages on behalf of the user." }, "agentEngine": { "description": "Optional. The resource name of the Agent Engine. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine} For example: projects/123/locations/us-central1/reasoningEngines/456", "type": "string" }, "geminiAgentConfig": { "$ref": "GoogleCloudAiplatformV1beta1GeminiAgentConfig", "description": "Optional. Config for scraping a Gemini Agent via the Interactions API. The scraping service creates interactions against the agent and returns the resulting interaction traces for evaluation." } } }, "GoogleCloudAiplatformV1beta1ListModelMonitorsResponse": { "type": "object", "description": "Response message for ModelMonitoringService.ListModelMonitors", "properties": { "modelMonitors": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitor" }, "description": "List of ModelMonitor in the requested page." }, "nextPageToken": { "description": "A token to retrieve the next page of results. Pass to ListModelMonitorsRequest.page_token to obtain that page.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1ListModelMonitorsResponse" }, "GoogleCloudAiplatformV1beta1VertexRagStore": { "description": "Retrieve from Vertex RAG Store for grounding.", "properties": { "vectorDistanceThreshold": { "deprecated": true, "format": "double", "description": "Optional. Only return results with vector distance smaller than the threshold.", "type": "number" }, "ragRetrievalConfig": { "$ref": "GoogleCloudAiplatformV1beta1RagRetrievalConfig", "description": "Optional. The retrieval config for the Rag query." }, "ragResources": { "description": "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.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1VertexRagStoreRagResource" } }, "storeContext": { "description": "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.", "type": "boolean" }, "similarityTopK": { "description": "Optional. Number of top k results to return from the selected corpora.", "format": "int32", "deprecated": true, "type": "integer" }, "ragCorpora": { "deprecated": true, "type": "array", "items": { "type": "string" }, "description": "Optional. Deprecated. Please use rag_resources instead." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1VertexRagStore" }, "GoogleCloudAiplatformV1beta1ListDatasetVersionsResponse": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ListDatasetVersionsResponse", "description": "Response message for DatasetService.ListDatasetVersions.", "properties": { "datasetVersions": { "items": { "$ref": "GoogleCloudAiplatformV1beta1DatasetVersion" }, "type": "array", "description": "A list of DatasetVersions that matches the specified filter in the request." }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1CorpusStatus": { "type": "object", "description": "RagCorpus status.", "properties": { "errorStatus": { "description": "Output only. Only when the `state` field is ERROR.", "type": "string", "readOnly": true }, "state": { "readOnly": true, "type": "string", "enumDescriptions": [ "This state is not supposed to happen.", "RagCorpus resource entry is initialized, but hasn't done validation.", "RagCorpus is provisioned successfully and is ready to serve.", "RagCorpus is in a problematic situation. See `error_message` field for details." ], "description": "Output only. RagCorpus life state.", "enum": [ "UNKNOWN", "INITIALIZED", "ACTIVE", "ERROR" ] } }, "id": "GoogleCloudAiplatformV1beta1CorpusStatus" }, "GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedVertexVectorSearch": { "id": "GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedVertexVectorSearch", "type": "object", "description": "The config for the RAG-managed Vertex Vector Search 2.0.", "properties": { "collectionName": { "readOnly": true, "type": "string", "description": "Output only. The resource name of the Vector Search 2.0 Collection that RAG Created for the corpus. Only populated after the corpus is successfully created. Format: `projects/{project}/locations/{location}/collections/{collection_id}`" } } }, "GoogleCloudAiplatformV1beta1GroundednessSpec": { "properties": { "version": { "description": "Optional. Which version to use for evaluation.", "format": "int32", "type": "integer" } }, "id": "GoogleCloudAiplatformV1beta1GroundednessSpec", "type": "object", "description": "Spec for groundedness metric." }, "GoogleCloudAiplatformV1beta1CancelTuningJobRequest": { "description": "Request message for GenAiTuningService.CancelTuningJob.", "type": "object", "id": "GoogleCloudAiplatformV1beta1CancelTuningJobRequest", "properties": {} }, "GoogleCloudAiplatformV1beta1SharePointSourcesSharePointSource": { "properties": { "driveName": { "type": "string", "description": "The name of the drive to download from." }, "sharepointFolderPath": { "description": "The path of the SharePoint folder to download from.", "type": "string" }, "clientSecret": { "description": "The application secret for the app registered in Azure.", "$ref": "GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig" }, "sharepointSiteName": { "type": "string", "description": "The name of the SharePoint site to download from. This can be the site name or the site id." }, "clientId": { "description": "The Application ID for the app registered in Microsoft Azure Portal. The application must also be configured with MS Graph permissions \"Files.ReadAll\", \"Sites.ReadAll\" and BrowserSiteLists.Read.All.", "type": "string" }, "fileId": { "description": "Output only. The SharePoint file id. Output only.", "readOnly": true, "type": "string" }, "driveId": { "description": "The ID of the drive to download from.", "type": "string" }, "tenantId": { "description": "Unique identifier of the Azure Active Directory Instance.", "type": "string" }, "sharepointFolderId": { "type": "string", "description": "The ID of the SharePoint folder to download from." } }, "type": "object", "description": "An individual SharePointSource.", "id": "GoogleCloudAiplatformV1beta1SharePointSourcesSharePointSource" }, "GenaiVertexV1beta1VideoContent": { "id": "GenaiVertexV1beta1VideoContent", "type": "object", "description": "A video content block. ", "properties": { "uri": { "type": "string", "description": "The URI of the video." }, "data": { "type": "string", "description": "The video content.", "format": "byte" }, "mimeTypeString": { "type": "string", "description": "Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the \"mime_type\" JSON key." }, "resolution": { "enum": [ "MEDIA_RESOLUTION_UNSPECIFIED", "LOW", "MEDIUM", "HIGH", "ULTRA_HIGH" ], "description": "The resolution of the media.", "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "Low resolution.", "Medium resolution.", "High resolution.", "Ultra high resolution." ] }, "name": { "description": "A user-defined name for this content block. Can be referenced by the model in the final response.", "type": "string" }, "processingType": { "enumDescriptions": [ "Default. Uses model-specific processing (3.5 Pro+ --\u003e AGENTIC, older models --\u003e STATIC)", "Fixed-rate frame extraction. All frames placed in context.", "Model-driven dynamic navigation." ], "enum": [ "PROCESSING_UNSPECIFIED", "STATIC", "AGENTIC" ], "type": "string" }, "processingConfig": { "$ref": "GenaiVertexV1beta1VideoContentMediaProcessing" } } }, "GoogleCloudAiplatformV1beta1ArtifactTypeSchema": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ArtifactTypeSchema", "properties": { "instanceSchema": { "type": "string", "description": "Contains a raw YAML string, describing the format of the properties of the type." }, "schemaUri": { "description": "Points to a YAML file stored on Cloud Storage describing the format. Deprecated. Use PipelineArtifactTypeSchema.schema_title or PipelineArtifactTypeSchema.instance_schema instead.", "type": "string", "deprecated": true }, "schemaVersion": { "description": "The schema version of the artifact. If the value is not set, it defaults to the latest version in the system.", "type": "string" }, "schemaTitle": { "description": "The name of the type. The format of the title must be: `.`. Examples: - `aiplatform.Model` - `acme.CustomModel` When this field is set, the type must be pre-registered in the MLMD store.", "type": "string" } }, "description": "The definition of a artifact type in MLMD." }, "GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingInput": { "properties": { "metricSpec": { "$ref": "GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingSpec", "description": "Required. Spec for RubricBasedInstructionFollowing metric." }, "instance": { "description": "Required. Instance for RubricBasedInstructionFollowing metric.", "$ref": "GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingInstance" } }, "type": "object", "description": "Instance and metric spec for RubricBasedInstructionFollowing metric.", "id": "GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingInput" }, "GoogleCloudAiplatformV1beta1PipelineTaskRerunConfig": { "id": "GoogleCloudAiplatformV1beta1PipelineTaskRerunConfig", "description": "User provided rerun config to submit a rerun pipelinejob. This includes 1. Which task to rerun 2. User override input parameters and artifacts.", "properties": { "skipDownstreamTasks": { "description": "Optional. Whether to skip downstream tasks. Default value is False.", "type": "boolean" }, "skipTask": { "description": "Optional. Whether to skip this task. Default value is False.", "type": "boolean" }, "taskName": { "description": "Optional. The name of the task.", "type": "string" }, "inputs": { "$ref": "GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigInputs", "description": "Optional. The runtime input of the task overridden by the user." }, "taskId": { "description": "Optional. The system generated ID of the task. Retrieved from original run.", "type": "string", "format": "int64" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1RagMetadataSchemaDetails": { "description": "Data schema details indicates the data type and the data struct corresponding to the key of user specified metadata.", "properties": { "listConfig": { "description": "Config for List data type.", "$ref": "GoogleCloudAiplatformV1beta1RagMetadataSchemaDetailsListConfig" }, "type": { "type": "string", "enumDescriptions": [ "Unspecified type.", "Integer type.", "Float type.", "String type.", "Supported formats: %Y-%m-%dT%H:%M:%E*S%E*z (absl::RFC3339_full) %Y-%m-%dT%H:%M:%E*S %Y-%m-%dT%H:%M%E*z %Y-%m-%dT%H:%M %Y-%m-%dT%H%E*z %Y-%m-%dT%H %Y-%m-%d%E*z %Y-%m-%d %Y-%m %Y", "Boolean type.", "List type. - Each element in the list must be of the exact same data schema; otherwise, they are invalid arguments. - Elements cannot be another list (no list of list)." ], "enum": [ "DATA_TYPE_UNSPECIFIED", "INTEGER", "FLOAT", "STRING", "DATETIME", "BOOLEAN", "LIST" ], "description": "Type of the metadata." }, "searchStrategy": { "description": "The search strategy for the metadata value of the `key`.", "$ref": "GoogleCloudAiplatformV1beta1RagMetadataSchemaDetailsSearchStrategy" }, "granularity": { "enum": [ "GRANULARITY_UNSPECIFIED", "GRANULARITY_FILE_LEVEL" ], "description": "The granularity associated with this RagMetadataSchema.", "type": "string", "enumDescriptions": [ "Unspecified granularity.", "RagFile-level granularity." ] } }, "id": "GoogleCloudAiplatformV1beta1RagMetadataSchemaDetails", "type": "object" }, "GoogleCloudAiplatformV1beta1AppendA2ATaskRecordEventsRequest": { "description": "Request message for A2ATaskRecordService.AppendA2ATaskRecordEvents.", "properties": { "events": { "items": { "$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordEvent" }, "type": "array", "description": "Required. The events to append to the task." }, "generation": { "description": "Required. The current task generation.", "type": "string", "format": "int64" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1AppendA2ATaskRecordEventsRequest" }, "GoogleCloudAiplatformV1beta1ListFeaturestoresResponse": { "type": "object", "description": "Response message for FeaturestoreService.ListFeaturestores.", "properties": { "featurestores": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Featurestore" }, "description": "The Featurestores matching the request.", "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as ListFeaturestoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1ListFeaturestoresResponse" }, "GoogleCloudAiplatformV1beta1Transcription": { "description": "Audio transcription in Server Content.", "id": "GoogleCloudAiplatformV1beta1Transcription", "type": "object", "properties": { "finished": { "description": "Optional. The bool indicates the end of the transcription.", "type": "boolean" }, "text": { "type": "string", "description": "Optional. Transcription text." } } }, "GoogleCloudAiplatformV1beta1SchemaImageDataItem": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaImageDataItem", "properties": { "gcsUri": { "description": "Required. Google Cloud Storage URI points to the original image in user's bucket. The image is up to 30MB in size.", "type": "string" }, "mimeType": { "description": "Output only. The mime type of the content of the image. Only the images in below listed mime types are supported. - image/jpeg - image/gif - image/png - image/webp - image/bmp - image/tiff - image/vnd.microsoft.icon", "type": "string", "readOnly": true } }, "description": "Payload of Image DataItem." }, "GenaiVertexV1beta1GoogleSearchResultStepGoogleSearchResultItem": { "id": "GenaiVertexV1beta1GoogleSearchResultStepGoogleSearchResultItem", "description": "The result of the Google Search.", "type": "object", "properties": { "searchSuggestions": { "description": "Web content snippet that can be embedded in a web page or an app webview.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1StudySpecDecayCurveAutomatedStoppingSpec": { "properties": { "useElapsedDuration": { "description": "True if Measurement.elapsed_duration is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.step_count will be used as the x-axis.", "type": "boolean" } }, "description": "The decay curve automated stopping rule builds a Gaussian Process Regressor to predict the final objective value of a Trial based on the already completed Trials and the intermediate measurements of the current Trial. Early stopping is requested for the current Trial if there is very low probability to exceed the optimal value found so far.", "id": "GoogleCloudAiplatformV1beta1StudySpecDecayCurveAutomatedStoppingSpec", "type": "object" }, "GoogleCloudAiplatformV1beta1CreateModelMonitorOperationMetadata": { "id": "GoogleCloudAiplatformV1beta1CreateModelMonitorOperationMetadata", "properties": { "genericMetadata": { "description": "The operation generic information.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "type": "object", "description": "Runtime operation information for ModelMonitoringService.CreateModelMonitor." }, "CloudAiLargeModelsVisionRaiInfo": { "id": "CloudAiLargeModelsVisionRaiInfo", "properties": { "scores": { "type": "array", "description": "List of rai scores mapping to the rai categories. Rounded to 1 decimal place.", "items": { "format": "float", "type": "number" } }, "blockedEntities": { "description": "List of blocked entities from the blocklist if it is detected.", "items": { "type": "string" }, "type": "array" }, "raiCategories": { "description": "List of rai categories' information to return", "type": "array", "items": { "type": "string" } }, "modelName": { "type": "string", "description": "The model name used to indexing into the RaiFilterConfig map. Would either be one of imagegeneration@002-006, imagen-3.0-... api endpoint names, or internal names used for mapping to different filter configs (genselfie, ai_watermark) than its api endpoint." }, "detectedLabels": { "items": { "$ref": "CloudAiLargeModelsVisionRaiInfoDetectedLabels" }, "description": "The list of detected labels for different rai categories.", "type": "array" } }, "description": "Next ID: 6", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaPromptInstancePromptExecution": { "type": "object", "description": "A prompt instance's parameters set that contains a set of variable values.", "id": "GoogleCloudAiplatformV1beta1SchemaPromptInstancePromptExecution", "properties": { "arguments": { "description": "Maps variable names to their value.", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1SchemaPromptInstanceVariableValue" }, "type": "object" } } }, "GoogleCloudAiplatformV1beta1ReadTensorboardUsageResponse": { "description": "Response message for TensorboardService.ReadTensorboardUsage.", "type": "object", "properties": { "monthlyUsageData": { "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardUsageResponsePerMonthUsageData" }, "type": "object", "description": "Maps year-month (YYYYMM) string to per month usage data." } }, "id": "GoogleCloudAiplatformV1beta1ReadTensorboardUsageResponse" }, "GoogleCloudAiplatformV1beta1ReasoningEngineSpecPackageSpec": { "properties": { "requirementsGcsUri": { "description": "Optional. The Cloud Storage URI of the `requirements.txt` file", "type": "string" }, "dependencyFilesGcsUri": { "type": "string", "description": "Optional. The Cloud Storage URI of the dependency files in tar.gz format." }, "pythonVersion": { "type": "string", "description": "Optional. The Python version. Supported values are 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10." }, "pickleObjectGcsUri": { "description": "Optional. The Cloud Storage URI of the pickled python object.", "type": "string" } }, "description": "User-provided package specification, containing pickled object and package requirements.", "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecPackageSpec", "type": "object" }, "GoogleCloudAiplatformV1beta1UpsertDatapointsRequest": { "description": "Request message for IndexService.UpsertDatapoints", "id": "GoogleCloudAiplatformV1beta1UpsertDatapointsRequest", "properties": { "datapoints": { "items": { "$ref": "GoogleCloudAiplatformV1beta1IndexDatapoint" }, "type": "array", "description": "A list of datapoints to be created/updated." }, "updateMask": { "description": "Optional. Update mask is used to specify the fields to be overwritten in the datapoints by the update. The fields specified in the update_mask are relative to each IndexDatapoint inside datapoints, not the full request. Updatable fields: * Use `all_restricts` to update both restricts and numeric_restricts.", "type": "string", "format": "google-fieldmask" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1AgentData": { "description": "Represents data specific to multi-turn agent evaluations.", "type": "object", "properties": { "turns": { "items": { "$ref": "GoogleCloudAiplatformV1beta1ConversationTurn" }, "type": "array", "description": "Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -\u003e Agent Response)." }, "agents": { "type": "object", "description": "Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent.", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1AgentConfig" } } }, "id": "GoogleCloudAiplatformV1beta1AgentData" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity": { "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity", "type": "object", "description": "A duration of time expressed in time granularity units.", "properties": { "unit": { "type": "string", "description": "The time granularity unit of this time period. The supported units are: * \"minute\" * \"hour\" * \"day\" * \"week\" * \"month\" * \"year\"" }, "quantity": { "description": "The number of granularity_units between data points in the training data. If `granularity_unit` is `minute`, can be 1, 5, 10, 15, or 30. For all other values of `granularity_unit`, must be 1.", "format": "int64", "type": "string" } } }, "GoogleCloudAiplatformV1beta1ExplanationMetadataOverride": { "id": "GoogleCloudAiplatformV1beta1ExplanationMetadataOverride", "description": "The ExplanationMetadata entries that can be overridden at online explanation time.", "properties": { "inputs": { "type": "object", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1ExplanationMetadataOverrideInputMetadataOverride" }, "description": "Required. Overrides the input metadata of the features. The key is the name of the feature to be overridden. The keys specified here must exist in the input metadata to be overridden. If a feature is not specified here, the corresponding feature's input metadata is not overridden." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ImportFeatureValuesResponse": { "type": "object", "properties": { "timestampOutsideRetentionRowsCount": { "description": "The number rows that weren't ingested due to having feature timestamps outside the retention boundary.", "format": "int64", "type": "string" }, "importedFeatureValueCount": { "description": "Number of Feature values that have been imported by the operation.", "type": "string", "format": "int64" }, "invalidRowCount": { "description": "The number of rows in input source that weren't imported due to either * Not having any featureValues. * Having a null entityId. * Having a null timestamp. * Not being parsable (applicable for CSV sources).", "format": "int64", "type": "string" }, "importedEntityCount": { "format": "int64", "description": "Number of entities that have been imported by the operation.", "type": "string" } }, "description": "Response message for FeaturestoreService.ImportFeatureValues.", "id": "GoogleCloudAiplatformV1beta1ImportFeatureValuesResponse" }, "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfig": { "type": "object", "description": "Config for the embedding model to use for RAG.", "properties": { "vertexPredictionEndpoint": { "description": "The Vertex AI Prediction Endpoint that either refers to a publisher model or an endpoint that is hosting a 1P fine-tuned text embedding model. Endpoints hosting non-1P fine-tuned text embedding models are currently not supported. This is used for dense vector search.", "$ref": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigVertexPredictionEndpoint" }, "hybridSearchConfig": { "$ref": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigHybridSearchConfig", "description": "Configuration for hybrid search." } }, "id": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfig" }, "GoogleCloudAiplatformV1beta1FindNeighborsRequestQueryRRF": { "id": "GoogleCloudAiplatformV1beta1FindNeighborsRequestQueryRRF", "type": "object", "properties": { "alpha": { "description": "Required. Users can provide an alpha value to give more weight to dense vs sparse results. For example, if the alpha is 0, we only return sparse and if the alpha is 1, we only return dense.", "format": "float", "type": "number" } }, "description": "Parameters for RRF algorithm that combines search results." }, "GoogleCloudAiplatformV1beta1PredefinedMetricSpec": { "properties": { "metricSpecParameters": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. The parameters needed to run the pre-defined metric." }, "metricSpecName": { "type": "string", "description": "Required. The name of a pre-defined metric, such as \"instruction_following_v1\" or \"text_quality_v1\"." } }, "description": "The spec for a pre-defined metric.", "id": "GoogleCloudAiplatformV1beta1PredefinedMetricSpec", "type": "object" }, "GoogleCloudAiplatformV1beta1ReadTensorboardBlobDataResponse": { "id": "GoogleCloudAiplatformV1beta1ReadTensorboardBlobDataResponse", "description": "Response message for TensorboardService.ReadTensorboardBlobData.", "type": "object", "properties": { "blobs": { "items": { "$ref": "GoogleCloudAiplatformV1beta1TensorboardBlob" }, "type": "array", "description": "Blob messages containing blob bytes." } } }, "GoogleCloudAiplatformV1beta1ListEvaluationItemsResponse": { "type": "object", "properties": { "nextPageToken": { "description": "A token to retrieve the next page of results.", "type": "string" }, "evaluationItems": { "description": "List of EvaluationItems in the requested page.", "items": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationItem" }, "type": "array" } }, "id": "GoogleCloudAiplatformV1beta1ListEvaluationItemsResponse", "description": "Response message for EvaluationManagementService.ListEvaluationItems." }, "GenaiVertexV1beta1Function": { "description": "A tool that can be used by the model.", "id": "GenaiVertexV1beta1Function", "properties": { "parameters": { "description": "The JSON Schema for the function's parameters.", "$ref": "GenaiVertexV1beta1Value" }, "description": { "description": "A description of the function.", "type": "string" }, "name": { "type": "string", "description": "The name of the function." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1AvroSource": { "properties": { "gcsSource": { "$ref": "GoogleCloudAiplatformV1beta1GcsSource", "description": "Required. Google Cloud Storage location." } }, "id": "GoogleCloudAiplatformV1beta1AvroSource", "type": "object", "description": "The storage details for Avro input content." }, "GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary": { "properties": { "detectorIds": { "description": "The list of detectors summaries for this severity level.", "items": { "type": "string" }, "type": "array" }, "sessionsCount": { "format": "int32", "type": "integer", "description": "Output only. The number of distinct sessions whose maximum severity equals `severity_level`. Each session is counted in exactly one bucket (its highest severity). Scope depends on where this appears: a global count on `AggregateAnalyzedSessionsResponse.summary`, per-agent on `agent_aggregates` entries, and page-scoped on `ListAnalyzedSessionsResponse`.", "readOnly": true }, "severityLevel": { "description": "The severity level of the detector.", "enumDescriptions": [ "Unspecified severity.", "Low severity.", "Medium severity.", "High severity.", "Critical severity." ], "type": "string", "enum": [ "SEVERITY_UNSPECIFIED", "SEVERITY_LOW", "SEVERITY_MEDIUM", "SEVERITY_HIGH", "SEVERITY_CRITICAL" ] } }, "description": "Breaks down anomalies by severity.", "type": "object", "id": "GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary" }, "GoogleCloudAiplatformV1beta1EvaluationRun": { "description": "EvaluationRun is a resource that represents a single evaluation run, which includes a set of prompts, model responses, evaluation configuration and the resulting metrics.", "type": "object", "properties": { "labels": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Optional. Labels for the evaluation run." }, "dataSource": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunDataSource", "description": "Required. The data source for the evaluation run." }, "evaluationSetSnapshot": { "type": "string", "readOnly": true, "description": "Output only. The specific evaluation set of the evaluation run. For runs with an evaluation set input, this will be that same set. For runs with BigQuery input, it's the sampled BigQuery dataset." }, "error": { "$ref": "GoogleRpcStatus", "readOnly": true, "description": "Output only. Only populated when the evaluation run's state is FAILED or CANCELLED." }, "metadata": { "type": "any", "description": "Optional. Metadata about the evaluation run, can be used by the caller to store additional tracking information about the evaluation run." }, "inferenceConfigs": { "description": "Optional. The candidate to inference config map for the evaluation run. The candidate can be up to 128 characters long and can consist of any UTF-8 characters.", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfig" }, "type": "object" }, "evaluationConfig": { "description": "Optional. The configuration used for the evaluation. Optional when analysis_configs is provided.", "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfig" }, "completionTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. Time when the evaluation run was completed." }, "name": { "type": "string", "description": "Identifier. The resource name of the EvaluationRun. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`" }, "createTime": { "format": "google-datetime", "description": "Output only. Time when the evaluation run was created.", "type": "string", "readOnly": true }, "displayName": { "description": "Required. The display name of the Evaluation Run.", "type": "string" }, "evaluationResults": { "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1EvaluationResults", "description": "Output only. The results of the evaluation run. Only populated when the evaluation run's state is SUCCEEDED." }, "encryptionSpec": { "description": "Optional. Customer-managed encryption key spec for this EvaluationRun. If set, this EvaluationRun will be secured by this key.", "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec" }, "state": { "description": "Output only. The state of the evaluation run.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified state.", "The evaluation run is pending.", "The evaluation run is running.", "The evaluation run has succeeded.", "The evaluation run has failed.", "The evaluation run has been cancelled.", "The evaluation run is performing inference.", "The evaluation run is performing rubric generation.", "The evaluation run is performing loss analysis." ], "enum": [ "STATE_UNSPECIFIED", "PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED", "INFERENCE", "GENERATING_RUBRICS", "GENERATING_LOSS_CLUSTERS" ] } }, "id": "GoogleCloudAiplatformV1beta1EvaluationRun" }, "GoogleCloudAiplatformV1beta1CsvSource": { "properties": { "gcsSource": { "description": "Required. Google Cloud Storage location.", "$ref": "GoogleCloudAiplatformV1beta1GcsSource" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1CsvSource", "description": "The storage details for CSV input content." }, "GoogleCloudAiplatformV1beta1DeleteFeatureValuesRequest": { "id": "GoogleCloudAiplatformV1beta1DeleteFeatureValuesRequest", "type": "object", "properties": { "selectEntity": { "$ref": "GoogleCloudAiplatformV1beta1DeleteFeatureValuesRequestSelectEntity", "description": "Select feature values to be deleted by specifying entities." }, "selectTimeRangeAndFeature": { "$ref": "GoogleCloudAiplatformV1beta1DeleteFeatureValuesRequestSelectTimeRangeAndFeature", "description": "Select feature values to be deleted by specifying time range and features." } }, "description": "Request message for FeaturestoreService.DeleteFeatureValues." }, "GenaiVertexV1beta1GoogleMapsCallContent": { "description": "Google Maps content.", "type": "object", "deprecated": true, "properties": { "arguments": { "$ref": "GenaiVertexV1beta1GoogleMapsCallContentGoogleMapsCallArguments", "description": "The arguments to pass to the Google Maps tool." } }, "id": "GenaiVertexV1beta1GoogleMapsCallContent" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation": { "type": "object", "properties": { "columnName": { "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation", "description": "Training pipeline will perform following transformation functions. * The categorical string as is--no change to case, punctuation, spelling, tense, and so on. * Convert the category name to a dictionary lookup index and generate an embedding for each index. * Categories that appear less than 5 times in the training dataset are treated as the \"unknown\" category. The \"unknown\" category gets its own special lookup index and resulting embedding." }, "GoogleCloudAiplatformV1beta1CometResult": { "type": "object", "id": "GoogleCloudAiplatformV1beta1CometResult", "properties": { "score": { "readOnly": true, "type": "number", "description": "Output only. Comet score. Range depends on version.", "format": "float" } }, "description": "Spec for Comet result - calculates the comet score for the given instance using the version specified in the spec." }, "GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStoreRagResource": { "id": "GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStoreRagResource", "properties": { "ragCorpus": { "description": "Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", "type": "string" }, "ragFileIds": { "type": "array", "items": { "type": "string" }, "description": "Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field." } }, "type": "object", "description": "The definition of the Rag resource." }, "GoogleCloudAiplatformV1beta1InputDataConfig": { "id": "GoogleCloudAiplatformV1beta1InputDataConfig", "description": "Specifies Vertex AI owned input data to be used for training, and possibly evaluating, the Model.", "properties": { "stratifiedSplit": { "description": "Supported only for tabular Datasets. Split based on the distribution of the specified column.", "$ref": "GoogleCloudAiplatformV1beta1StratifiedSplit" }, "bigqueryDestination": { "$ref": "GoogleCloudAiplatformV1beta1BigQueryDestination", "description": "Only applicable to custom training with tabular Dataset with BigQuery source. The BigQuery project location where the training data is to be written to. In the given project a new dataset is created with name `dataset___` where timestamp is in YYYY_MM_DDThh_mm_ss_sssZ format. All training input data is written into that dataset. In the dataset three tables are created, `training`, `validation` and `test`. * AIP_DATA_FORMAT = \"bigquery\". * AIP_TRAINING_DATA_URI = \"bigquery_destination.dataset___.training\" * AIP_VALIDATION_DATA_URI = \"bigquery_destination.dataset___.validation\" * AIP_TEST_DATA_URI = \"bigquery_destination.dataset___.test\"" }, "savedQueryId": { "description": "Only applicable to Datasets that have SavedQueries. The ID of a SavedQuery (annotation set) under the Dataset specified by dataset_id used for filtering Annotations for training. Only Annotations that are associated with this SavedQuery are used in respectively training. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both saved_query_id and annotations_filter. Only one of saved_query_id and annotation_schema_uri should be specified as both of them represent the same thing: problem type.", "type": "string" }, "annotationsFilter": { "description": "Applicable only to Datasets that have DataItems and Annotations. A filter on Annotations of the Dataset. Only Annotations that both match this filter and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on (for the auto-assigned that role is decided by Vertex AI). A filter with same syntax as the one used in ListAnnotations may be used, but note here it filters across all Annotations of the Dataset, and not just within a single DataItem.", "type": "string" }, "timestampSplit": { "description": "Supported only for tabular Datasets. Split based on the timestamp of the input data pieces.", "$ref": "GoogleCloudAiplatformV1beta1TimestampSplit" }, "fractionSplit": { "$ref": "GoogleCloudAiplatformV1beta1FractionSplit", "description": "Split based on fractions defining the size of each set." }, "filterSplit": { "description": "Split based on the provided filters for each set.", "$ref": "GoogleCloudAiplatformV1beta1FilterSplit" }, "annotationSchemaUri": { "type": "string", "description": "Applicable only to custom training with Datasets that have DataItems and Annotations. Cloud Storage URI that points to a YAML file describing the annotation schema. 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). The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/ , note that the chosen schema must be consistent with metadata of the Dataset specified by dataset_id. Only Annotations that both match this schema and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both annotations_filter and annotation_schema_uri." }, "predefinedSplit": { "description": "Supported only for tabular Datasets. Split based on a predefined key.", "$ref": "GoogleCloudAiplatformV1beta1PredefinedSplit" }, "gcsDestination": { "description": "The Cloud Storage location where the training data is to be written to. In the given directory a new directory is created with name: `dataset---` where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. All training input data is written into that directory. The Vertex AI environment variables representing Cloud Storage data URIs are represented in the Cloud Storage wildcard format to support sharded data. e.g.: \"gs://.../training-*.jsonl\" * AIP_DATA_FORMAT = \"jsonl\" for non-tabular data, \"csv\" for tabular data * AIP_TRAINING_DATA_URI = \"gcs_destination/dataset---/training-*.${AIP_DATA_FORMAT}\" * AIP_VALIDATION_DATA_URI = \"gcs_destination/dataset---/validation-*.${AIP_DATA_FORMAT}\" * AIP_TEST_DATA_URI = \"gcs_destination/dataset---/test-*.${AIP_DATA_FORMAT}\"", "$ref": "GoogleCloudAiplatformV1beta1GcsDestination" }, "datasetId": { "description": "Required. The ID of the Dataset in the same Project and Location which data will be used to train the Model. The Dataset must use schema compatible with Model being trained, and what is compatible should be described in the used TrainingPipeline's training_task_definition. For tabular Datasets, all their data is exported to training, to pick and choose from.", "type": "string" }, "persistMlUseAssignment": { "description": "Whether to persist the ML use assignment to data item system labels.", "type": "boolean" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1SetPublisherModelConfigRequest": { "type": "object", "description": "Request message for EndpointService.SetPublisherModelConfig.", "properties": { "publisherModelConfig": { "description": "Required. The publisher model config.", "$ref": "GoogleCloudAiplatformV1beta1PublisherModelConfig" }, "updateMask": { "type": "string", "description": "Optional. The fields of `publisher_model_config` to overwrite. If empty, the entire config is replaced. If set, only the listed fields are overwritten and the others are left unchanged; this lets you update one setting (for example `inference_event_logging_config`) without clearing its siblings.", "format": "google-fieldmask" } }, "id": "GoogleCloudAiplatformV1beta1SetPublisherModelConfigRequest" }, "GoogleCloudAiplatformV1beta1EvaluationConfig": { "properties": { "autoraterConfig": { "description": "Optional. Autorater config for evaluation.", "$ref": "GoogleCloudAiplatformV1beta1AutoraterConfig" }, "datasetCustomMetrics": { "description": "Optional. Specifications for custom dataset-level aggregations.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1DatasetCustomMetric" } }, "metrics": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Metric" }, "type": "array", "description": "Required. The metrics used for evaluation." }, "inferenceGenerationConfig": { "description": "Optional. Configuration options for inference generation and outputs. If not set, default generation parameters are used.", "$ref": "GoogleCloudAiplatformV1beta1GenerationConfig" }, "outputConfig": { "$ref": "GoogleCloudAiplatformV1beta1OutputConfig", "description": "Required. Config for evaluation output." } }, "type": "object", "description": "Evaluation Config for Tuning Job.", "id": "GoogleCloudAiplatformV1beta1EvaluationConfig" }, "GenaiVertexV1beta1ToolResultStep": { "type": "object", "id": "GenaiVertexV1beta1ToolResultStep", "properties": { "googleMapsResult": { "$ref": "GenaiVertexV1beta1GoogleMapsResultStep" }, "signature": { "format": "byte", "type": "string", "description": "A signature hash for backend validation." }, "retrievalResult": { "$ref": "GenaiVertexV1beta1RetrievalResultStep" }, "googleSearchResult": { "$ref": "GenaiVertexV1beta1GoogleSearchResultStep" }, "fileSearchResult": { "$ref": "GenaiVertexV1beta1FileSearchResultStep" }, "callId": { "type": "string", "description": "Required. ID to match the ID from the function call block." }, "processingResult": { "$ref": "GenaiVertexV1beta1ProcessingResultStep" }, "codeExecutionResult": { "$ref": "GenaiVertexV1beta1CodeExecutionResultStep" }, "mcpServerToolResult": { "$ref": "GenaiVertexV1beta1McpServerToolResultStep" }, "functionResult": { "$ref": "GenaiVertexV1beta1FunctionResultStep" }, "urlContextResult": { "$ref": "GenaiVertexV1beta1UrlContextResultStep" } }, "description": "Tool result step." }, "GoogleCloudAiplatformV1beta1FeatureViewDataKeyCompositeKey": { "description": "ID that is comprised from several parts (columns).", "properties": { "parts": { "type": "array", "items": { "type": "string" }, "description": "Parts to construct Entity ID. Should match with the same ID columns as defined in FeatureView in the same order." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1FeatureViewDataKeyCompositeKey" }, "GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigGenerationConfig": { "id": "GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigGenerationConfig", "type": "object", "properties": { "model": { "type": "string", "description": "Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`." }, "generationTriggerConfig": { "description": "Optional. Specifies the default trigger configuration for generating memories using `IngestEvents`.", "$ref": "GoogleCloudAiplatformV1beta1MemoryGenerationTriggerConfig" } }, "description": "Configuration for how to generate memories." }, "GenaiVertexV1beta1Step": { "properties": { "modelOutput": { "$ref": "GenaiVertexV1beta1ModelOutputStep" }, "thought": { "$ref": "GenaiVertexV1beta1ThoughtStep" }, "toolCall": { "$ref": "GenaiVertexV1beta1ToolCallStep" }, "toolResult": { "$ref": "GenaiVertexV1beta1ToolResultStep" }, "userInput": { "description": "DO NOT USE -- These are for 3P JSON only", "$ref": "GenaiVertexV1beta1UserInputStep" } }, "type": "object", "description": "A step in the interaction.", "id": "GenaiVertexV1beta1Step" }, "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigAutoraterConfig": { "type": "object", "description": "The autorater config used for the evaluation run.", "id": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigAutoraterConfig", "properties": { "sampleCount": { "type": "integer", "description": "Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.", "format": "int32" }, "generationConfig": { "description": "Optional. Configuration options for model generation and outputs.", "$ref": "GoogleCloudAiplatformV1beta1GenerationConfig" }, "autoraterModel": { "description": "Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "type": "string" } } }, "GenaiVertexV1beta1StepStart": { "id": "GenaiVertexV1beta1StepStart", "type": "object", "properties": { "step": { "$ref": "GenaiVertexV1beta1Step" }, "index": { "type": "integer", "format": "int32" } } }, "GoogleCloudAiplatformV1beta1NotebookRuntime": { "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.", "type": "object", "id": "GoogleCloudAiplatformV1beta1NotebookRuntime", "properties": { "createTime": { "description": "Output only. Timestamp when this NotebookRuntime was created.", "format": "google-datetime", "type": "string", "readOnly": true }, "labels": { "additionalProperties": { "type": "string" }, "type": "object", "description": "The labels with user-defined metadata to organize your NotebookRuntime. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable. Following system labels exist for NotebookRuntime: * \"aiplatform.googleapis.com/notebook_runtime_gce_instance_id\": output only, its value is the Compute Engine instance id. * \"aiplatform.googleapis.com/colab_enterprise_entry_service\": its value is either \"bigquery\" or \"vertex\"; if absent, it should be \"vertex\". This is to describe the entry service, either BigQuery or Vertex." }, "expirationTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when this NotebookRuntime will be expired: 1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted. 2. User created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade." }, "isUpgradable": { "type": "boolean", "readOnly": true, "description": "Output only. Whether NotebookRuntime is upgradable." }, "eucConfig": { "readOnly": true, "description": "Output only. EUC configuration of the notebook runtime.", "$ref": "GoogleCloudAiplatformV1beta1NotebookEucConfig" }, "name": { "type": "string", "description": "Output only. The resource name of the NotebookRuntime.", "readOnly": true }, "machineSpec": { "description": "Output only. The specification of a single machine used by the notebook runtime.", "$ref": "GoogleCloudAiplatformV1beta1MachineSpec", "readOnly": true }, "satisfiesPzs": { "type": "boolean", "readOnly": true, "description": "Output only. Reserved for future use." }, "networkTags": { "description": "Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).", "type": "array", "items": { "type": "string" } }, "displayName": { "type": "string", "description": "Required. The display name of the NotebookRuntime. The name can be up to 128 characters long and can consist of any UTF-8 characters." }, "proxyUri": { "description": "Output only. The proxy endpoint used to access the NotebookRuntime.", "type": "string", "readOnly": true }, "runtimeState": { "readOnly": true, "type": "string", "description": "Output only. The runtime (instance) state of the NotebookRuntime.", "enum": [ "RUNTIME_STATE_UNSPECIFIED", "RUNNING", "BEING_STARTED", "BEING_STOPPED", "STOPPED", "BEING_UPGRADED", "ERROR", "INVALID" ], "enumDescriptions": [ "Unspecified runtime state.", "NotebookRuntime is in running 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.", "NotebookRuntime was unable to start/stop properly.", "NotebookRuntime is in invalid state. Cannot be recovered." ] }, "runtimeUser": { "description": "Required. The user email of the NotebookRuntime.", "type": "string" }, "networkSpec": { "$ref": "GoogleCloudAiplatformV1beta1NetworkSpec", "description": "Output only. Network spec of the notebook runtime.", "readOnly": true }, "serviceAccount": { "readOnly": true, "description": "Output only. Deprecated: This field is no longer used and the \"Vertex AI Notebook Service Account\" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. The service account that the NotebookRuntime workload runs as.", "type": "string" }, "healthState": { "description": "Output only. The health state of the NotebookRuntime.", "enumDescriptions": [ "Unspecified health state.", "NotebookRuntime is in healthy state. Applies to ACTIVE state.", "NotebookRuntime is in unhealthy state. Applies to ACTIVE state." ], "readOnly": true, "type": "string", "enum": [ "HEALTH_STATE_UNSPECIFIED", "HEALTHY", "UNHEALTHY" ] }, "shieldedVmConfig": { "$ref": "GoogleCloudAiplatformV1beta1ShieldedVmConfig", "description": "Output only. Runtime Shielded VM spec.", "readOnly": true }, "dataPersistentDiskSpec": { "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1PersistentDiskSpec", "description": "Output only. The specification of persistent disk attached to the notebook runtime as data disk storage." }, "version": { "description": "Output only. The VM os image version of NotebookRuntime.", "type": "string", "readOnly": true }, "notebookRuntimeTemplateRef": { "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1NotebookRuntimeTemplateRef", "description": "Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from." }, "description": { "type": "string", "description": "The description of the NotebookRuntime." }, "softwareConfig": { "description": "Output only. Software config of the notebook runtime.", "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1NotebookSoftwareConfig" }, "encryptionSpec": { "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec", "readOnly": true, "description": "Output only. Customer-managed encryption key spec for the notebook runtime." }, "notebookRuntimeType": { "readOnly": true, "enum": [ "NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED", "USER_DEFINED", "ONE_CLICK" ], "description": "Output only. The type of the notebook runtime.", "type": "string", "enumDescriptions": [ "Unspecified notebook runtime type, NotebookRuntimeType will default to USER_DEFINED.", "runtime or template with coustomized configurations from user.", "runtime or template with system defined configurations." ] }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when this NotebookRuntime was most recently updated." }, "satisfiesPzi": { "type": "boolean", "readOnly": true, "description": "Output only. Reserved for future use." }, "reservationAffinity": { "description": "Output only. Reservation Affinity of the notebook runtime.", "$ref": "GoogleCloudAiplatformV1beta1NotebookReservationAffinity", "readOnly": true }, "idleShutdownConfig": { "description": "Output only. The idle shutdown configuration of the notebook runtime.", "$ref": "GoogleCloudAiplatformV1beta1NotebookIdleShutdownConfig", "readOnly": true } } }, "GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDbANN": { "id": "GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDbANN", "properties": { "treeDepth": { "type": "integer", "description": "The depth of the tree-based structure. Only depth values of 2 and 3 are supported. Recommended value is 2 if you have if you have O(10K) files in the RagCorpus and set this to 3 if more than that. Default value is 2.", "format": "int32" }, "leafCount": { "description": "Number of leaf nodes in the tree-based structure. Each leaf node contains groups of closely related vectors along with their corresponding centroid. Recommended value is 10 * sqrt(num of RagFiles in your RagCorpus). Default value is 500.", "format": "int32", "type": "integer" } }, "description": "Config for ANN search. RagManagedDb uses a tree-based structure to partition data and facilitate faster searches. As a tradeoff, it requires longer indexing time and manual triggering of index rebuild via the ImportRagFiles and UpdateRagCorpus API.", "type": "object" }, "GenaiVertexV1beta1ContentStop": { "type": "object", "id": "GenaiVertexV1beta1ContentStop", "properties": { "index": { "format": "int32", "type": "integer" } } }, "GoogleCloudAiplatformV1beta1SchemaTimeSeriesDatasetMetadataGcsSource": { "id": "GoogleCloudAiplatformV1beta1SchemaTimeSeriesDatasetMetadataGcsSource", "type": "object", "properties": { "uri": { "type": "array", "description": "Cloud Storage URI of one or more files. Only CSV files are supported. The first line of the CSV file is used as the header. If there are multiple files, the header is the first line of the lexicographically first file, the other files must either contain the exact same header or omit the header.", "items": { "type": "string" } } } }, "GoogleCloudAiplatformV1beta1TunedModelRef": { "type": "object", "description": "TunedModel Reference for legacy model migration.", "properties": { "tuningJob": { "description": "Support migration from tuning job list page, from gemini-1.0-pro-002 to 1.5 and above.", "type": "string" }, "tunedModel": { "description": "Support migration from model registry.", "type": "string" }, "pipelineJob": { "description": "Support migration from tuning job list page, from bison model to gemini model.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1TunedModelRef" }, "GoogleCloudAiplatformV1beta1ReinforcementTuningSpec": { "description": "Tuning spec for Reinforcement Tuning.", "type": "object", "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningSpec", "properties": { "trainingDatasetUri": { "description": "Cloud Storage path to the file containing training dataset for tuning. The dataset must be formatted as a JSONL file.", "type": "string" }, "singleRewardConfig": { "$ref": "GoogleCloudAiplatformV1beta1SingleReinforcementTuningRewardConfig", "description": "Single Reward function configuration for reinforcement tuning." }, "validationDatasetUri": { "description": "Cloud Storage path to the file containing validation dataset for tuning. The dataset must be formatted as a JSONL file.", "type": "string" }, "compositeRewardConfig": { "description": "Composite reward function configuration for reinforcement tuning.", "$ref": "GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfig" }, "hyperParameters": { "description": "Optional. Hyper-parameters for reinforcement tuning.", "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters" } } }, "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigOutputConfig": { "properties": { "bigqueryDestination": { "description": "BigQuery destination for evaluation output.", "$ref": "GoogleCloudAiplatformV1beta1BigQueryDestination" }, "gcsDestination": { "description": "Cloud Storage destination for evaluation output.", "$ref": "GoogleCloudAiplatformV1beta1GcsDestination" } }, "description": "The output config for the evaluation run.", "id": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigOutputConfig", "type": "object" }, "GoogleIamV1Binding": { "description": "Associates `members`, or principals, with a `role`.", "properties": { "role": { "type": "string", "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles)." }, "members": { "items": { "type": "string" }, "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", "type": "array" }, "condition": { "$ref": "GoogleTypeExpr", "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." } }, "id": "GoogleIamV1Binding", "type": "object" }, "GoogleCloudAiplatformV1beta1RagContextsContext": { "id": "GoogleCloudAiplatformV1beta1RagContextsContext", "type": "object", "properties": { "sourceDisplayName": { "description": "The file display name.", "type": "string" }, "sourceUri": { "description": "If the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name.", "type": "string" }, "sparseDistance": { "deprecated": true, "type": "number", "description": "The distance between the query sparse embedding vector and the context text vector.", "format": "double" }, "distance": { "format": "double", "description": "The distance between the query dense embedding vector and the context text vector.", "deprecated": true, "type": "number" }, "score": { "description": "According to the underlying Vector DB and the selected metric type, the score can be either the distance or the similarity between the query and the context and its range depends on the metric type. For example, if the metric type is COSINE_DISTANCE, it represents the distance between the query and the context. The larger the distance, the less relevant the context is to the query. The range is [0, 2], while 0 means the most relevant and 2 means the least relevant.", "format": "double", "type": "number" }, "chunk": { "description": "Context of the retrieved chunk.", "$ref": "GoogleCloudAiplatformV1beta1RagChunk" }, "text": { "type": "string", "description": "The text chunk." } }, "description": "A context of the query." }, "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecAgentConfigSourceAdkConfig": { "type": "object", "description": "Configuration for the Agent Development Kit (ADK).", "properties": { "jsonConfig": { "description": "Required. The value of the ADK config in JSON format.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecAgentConfigSourceAdkConfig" }, "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponse": { "type": "object", "properties": { "header": { "description": "Response header.", "$ref": "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponseHeader" }, "entityView": { "description": "Entity view with Feature values. This may be the entity in the Featurestore if values for all Features were requested, or a projection of the entity in the Featurestore if values for only some Features were requested.", "$ref": "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponseEntityView" } }, "id": "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponse", "description": "Response message for FeaturestoreOnlineServingService.ReadFeatureValues." }, "GoogleCloudAiplatformV1beta1RagVectorDbConfigWeaviate": { "id": "GoogleCloudAiplatformV1beta1RagVectorDbConfigWeaviate", "description": "The config for the Weaviate.", "type": "object", "properties": { "collectionName": { "type": "string", "description": "The corresponding collection this corpus maps to. This value cannot be changed after it's set." }, "httpEndpoint": { "type": "string", "description": "Weaviate DB instance HTTP endpoint. e.g. 34.56.78.90:8080 Vertex RAG only supports HTTP connection to Weaviate. This value cannot be changed after it's set." } } }, "GoogleCloudAiplatformV1beta1WriteFeatureValuesPayload": { "properties": { "featureValues": { "description": "Required. Feature values to be written, mapping from Feature ID to value. Up to 100,000 `feature_values` entries may be written across all payloads. The feature generation time, aligned by days, must be no older than five years (1825 days) and no later than one year (366 days) in the future.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1FeatureValue" } }, "entityId": { "description": "Required. The ID of the entity.", "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1WriteFeatureValuesPayload", "description": "Contains Feature values to be written for a specific entity." }, "GoogleCloudAiplatformV1beta1SafetyInstance": { "description": "Spec for safety instance.", "properties": { "prediction": { "type": "string", "description": "Required. Output of the evaluated model." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SafetyInstance" }, "GoogleCloudAiplatformV1beta1ListTensorboardRunsResponse": { "properties": { "nextPageToken": { "type": "string", "description": "A token, which can be sent as ListTensorboardRunsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "tensorboardRuns": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" }, "description": "The TensorboardRuns mathching the request." } }, "id": "GoogleCloudAiplatformV1beta1ListTensorboardRunsResponse", "description": "Response message for TensorboardService.ListTensorboardRuns.", "type": "object" }, "GoogleCloudAiplatformV1beta1GenerateLossClustersResponse": { "properties": { "analysisTime": { "description": "The timestamp when this analysis was completed.", "type": "string", "format": "google-datetime" }, "results": { "description": "The analysis results, one per config provided in the request.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1LossAnalysisResult" } } }, "id": "GoogleCloudAiplatformV1beta1GenerateLossClustersResponse", "type": "object", "description": "Response message for EvaluationAnalyticsService.GenerateLossClusters." }, "GoogleCloudAiplatformV1beta1PrivateEndpoints": { "properties": { "explainHttpUri": { "type": "string", "readOnly": true, "description": "Output only. Http(s) path to send explain requests." }, "predictHttpUri": { "description": "Output only. Http(s) path to send prediction requests.", "type": "string", "readOnly": true }, "serviceAttachment": { "type": "string", "readOnly": true, "description": "Output only. The name of the service attachment resource. Populated if private service connect is enabled." }, "healthHttpUri": { "readOnly": true, "type": "string", "description": "Output only. Http(s) path to send health check requests." } }, "description": "PrivateEndpoints proto is used to provide paths for users to send requests privately. To send request via private service access, use predict_http_uri, explain_http_uri or health_http_uri. To send request via private service connect, use service_attachment.", "id": "GoogleCloudAiplatformV1beta1PrivateEndpoints", "type": "object" }, "GoogleCloudAiplatformV1beta1StreamingReadFeatureValuesRequest": { "properties": { "featureSelector": { "description": "Required. Selector choosing Features of the target EntityType. Feature IDs will be deduplicated.", "$ref": "GoogleCloudAiplatformV1beta1FeatureSelector" }, "entityIds": { "items": { "type": "string" }, "type": "array", "description": "Required. IDs of entities to read Feature values of. The maximum number of IDs is 100. For example, for a machine learning model predicting user clicks on a website, an entity ID could be `user_123`." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1StreamingReadFeatureValuesRequest", "description": "Request message for FeaturestoreOnlineServingService.StreamingReadFeatureValues." }, "GoogleCloudAiplatformV1beta1StratifiedSplit": { "id": "GoogleCloudAiplatformV1beta1StratifiedSplit", "type": "object", "description": "Assigns input data to the training, validation, and test sets so that the distribution of values found in the categorical column (as specified by the `key` field) is mirrored within each split. The fraction values determine the relative sizes of the splits. For example, if the specified column has three values, with 50% of the rows having value \"A\", 25% value \"B\", and 25% value \"C\", and the split fractions are specified as 80/10/10, then the training set will constitute 80% of the training data, with about 50% of the training set rows having the value \"A\" for the specified column, about 25% having the value \"B\", and about 25% having the value \"C\". Only the top 500 occurring values are used; any values not in the top 500 values are randomly assigned to a split. If less than three rows contain a specific value, those rows are randomly assigned. Supported only for tabular Datasets.", "properties": { "trainingFraction": { "type": "number", "format": "double", "description": "The fraction of the input data that is to be used to train the Model." }, "testFraction": { "type": "number", "format": "double", "description": "The fraction of the input data that is to be used to evaluate the Model." }, "key": { "type": "string", "description": "Required. The key is a name of one of the Dataset's data columns. The key provided must be for a categorical column." }, "validationFraction": { "description": "The fraction of the input data that is to be used to validate the Model.", "format": "double", "type": "number" } } }, "GoogleCloudAiplatformV1beta1VoiceConfig": { "properties": { "prebuiltVoiceConfig": { "$ref": "GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig", "description": "The configuration for a prebuilt voice." }, "replicatedVoiceConfig": { "description": "Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.", "$ref": "GoogleCloudAiplatformV1beta1ReplicatedVoiceConfig" } }, "description": "Configuration for a voice.", "type": "object", "id": "GoogleCloudAiplatformV1beta1VoiceConfig" }, "GenaiVertexV1beta1ToolCallStep": { "id": "GenaiVertexV1beta1ToolCallStep", "type": "object", "description": "Tool call step.", "properties": { "googleMapsCall": { "$ref": "GenaiVertexV1beta1GoogleMapsCallStep" }, "processingCall": { "$ref": "GenaiVertexV1beta1ProcessingCallStep" }, "mcpServerToolCall": { "$ref": "GenaiVertexV1beta1McpServerToolCallStep" }, "fileSearchCall": { "$ref": "GenaiVertexV1beta1FileSearchCallStep" }, "id": { "description": "Required. A unique ID for this specific tool call.", "type": "string" }, "signature": { "description": "A signature hash for backend validation.", "type": "string", "format": "byte" }, "codeExecutionCall": { "$ref": "GenaiVertexV1beta1CodeExecutionCallStep" }, "retrievalCall": { "$ref": "GenaiVertexV1beta1RetrievalCallStep" }, "urlContextCall": { "$ref": "GenaiVertexV1beta1UrlContextCallStep" }, "googleSearchCall": { "$ref": "GenaiVertexV1beta1GoogleSearchCallStep" }, "functionCall": { "$ref": "GenaiVertexV1beta1FunctionCallStep" } } }, "GoogleCloudAiplatformV1beta1SchemaTimeSeriesDatasetMetadataBigQuerySource": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaTimeSeriesDatasetMetadataBigQuerySource", "properties": { "uri": { "type": "string", "description": "The URI of a BigQuery table." } } }, "GoogleCloudAiplatformV1beta1GenAiAdvancedFeaturesConfigRagConfig": { "properties": { "enableRag": { "description": "If true, enable Retrieval Augmented Generation in ChatCompletion request. Once enabled, the endpoint will be identified as GenAI endpoint and Arthedain router will be used.", "type": "boolean" } }, "id": "GoogleCloudAiplatformV1beta1GenAiAdvancedFeaturesConfigRagConfig", "description": "Configuration for Retrieval Augmented Generation feature.", "type": "object" }, "GenaiVertexV1beta1McpServerToolCallContent": { "type": "object", "properties": { "arguments": { "$ref": "GenaiVertexV1beta1Struct", "description": "Required. The JSON object of arguments for the function." }, "name": { "description": "Required. The name of the tool which was called.", "type": "string" }, "serverName": { "description": "Required. The name of the used MCP server.", "type": "string" } }, "id": "GenaiVertexV1beta1McpServerToolCallContent", "description": "MCPServer tool call content." }, "GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfigWeightedRewardConfig": { "id": "GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfigWeightedRewardConfig", "description": "Reward function configuration with a weight. The weight is used to combine the reward with other rewards.", "type": "object", "properties": { "weight": { "format": "float", "description": "How much this single reward contributes to the total overall reward. Total reward is a linear combination of single rewards with their corresponding weights, i.e., ``` total_reward = ( weight_a * reward_a + weight_b * reward_b + ... ) / (weight_a + weight_b + ...) ```", "type": "number" }, "rewardConfig": { "description": "Single reward configuration.", "$ref": "GoogleCloudAiplatformV1beta1SingleReinforcementTuningRewardConfig" } } }, "GoogleCloudAiplatformV1beta1ModelMonitoringAlertConfigEmailAlertConfig": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ModelMonitoringAlertConfigEmailAlertConfig", "description": "The config for email alert.", "properties": { "userEmails": { "items": { "type": "string" }, "description": "The email addresses to send the alert.", "type": "array" } } }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation", "description": "Training pipeline will infer the proper transformation based on the statistic of dataset.", "properties": { "columnName": { "type": "string" } } }, "GoogleCloudAiplatformV1beta1UnmanagedContainerModel": { "id": "GoogleCloudAiplatformV1beta1UnmanagedContainerModel", "type": "object", "description": "Contains model information necessary to perform batch prediction without requiring a full model import.", "properties": { "containerSpec": { "$ref": "GoogleCloudAiplatformV1beta1ModelContainerSpec", "description": "Input only. The specification of the container that is to be used when deploying this Model." }, "artifactUri": { "type": "string", "description": "The path to the directory containing the Model artifact and any of its supporting files." }, "predictSchemata": { "$ref": "GoogleCloudAiplatformV1beta1PredictSchemata", "description": "Contains the schemata used in Model's predictions and explanations" } } }, "GoogleCloudAiplatformV1beta1EvaluationRubricConfig": { "id": "GoogleCloudAiplatformV1beta1EvaluationRubricConfig", "type": "object", "properties": { "predefinedRubricGenerationSpec": { "description": "Dynamically generate rubrics using a predefined spec.", "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunMetricPredefinedMetricSpec" }, "rubricGroupKey": { "type": "string", "description": "Required. The key used to save the generated rubrics. If a generation spec is provided, this key will be used for the name of the generated rubric group. Otherwise, this key will be used to look up the existing rubric group on the evaluation item. Note that if a rubric group key is specified on both a rubric config and an evaluation metric, the key from the metric will be used to select the rubrics for evaluation." }, "rubricGenerationSpec": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricGenerationSpec", "description": "Dynamically generate rubrics using this specification." } }, "description": "Configuration for a rubric group to be generated/saved for evaluation." }, "GoogleCloudAiplatformV1beta1SignUpRequest": { "description": "Request message for ExpressModeService.SignUp.", "type": "object", "properties": { "tosAccepted": { "type": "boolean", "description": "Required. Whether the Terms of Service are accepted." }, "region": { "description": "Required. The desired region for the express project.", "type": "string" }, "getDefaultApiKey": { "description": "Optional. Whether to return the default API key string in the response.", "type": "boolean" } }, "id": "GoogleCloudAiplatformV1beta1SignUpRequest" }, "GoogleCloudAiplatformV1beta1ProcessDataRequestVeoSpec": { "id": "GoogleCloudAiplatformV1beta1ProcessDataRequestVeoSpec", "type": "object", "properties": { "processType": { "enum": [ "VEO_V1_AND_V2_DEFAULT", "VEO_V3" ], "type": "string", "description": "Optional. The type of data processing to perform.", "enumDescriptions": [ "Process type for Veo 1 and 2.", "Process type for Veo 3." ] } }, "description": "Spec for Veo data processing." }, "GoogleCloudAiplatformV1beta1ToolParameterKeyMatchResults": { "description": "Results for tool parameter key match metric.", "properties": { "toolParameterKeyMatchMetricValues": { "description": "Output only. Tool parameter key match metric values.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1ToolParameterKeyMatchMetricValue" } } }, "id": "GoogleCloudAiplatformV1beta1ToolParameterKeyMatchResults", "type": "object" }, "GoogleCloudAiplatformV1beta1PersistentDiskSpec": { "properties": { "diskType": { "type": "string", "description": "Type of the disk (default is \"pd-standard\"). Valid values: \"pd-ssd\" (Persistent Disk Solid State Drive) \"pd-standard\" (Persistent Disk Hard Disk Drive) \"pd-balanced\" (Balanced Persistent Disk) \"pd-extreme\" (Extreme Persistent Disk) \"hyperdisk-balanced\" (Hyperdisk Balanced) \"hyperdisk-extreme\" (Hyperdisk Extreme) \"hyperdisk-balanced-high-availability\" (Hyperdisk Balanced High Availability) \"hyperdisk-ml\" (Hyperdisk ML) \"hyperdisk-throughput\" (Hyperdisk Throughput)" }, "diskSizeGb": { "format": "int64", "description": "Size in GB of the disk (default is 100GB).", "type": "string" } }, "description": "Represents the spec of persistent disk and hyperdisk options.", "id": "GoogleCloudAiplatformV1beta1PersistentDiskSpec", "type": "object" }, "GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardResponse": { "properties": { "rewardInfoDetails": { "type": "object", "description": "A map from reward name to reward info.", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningRewardInfo" } }, "errorStatus": { "readOnly": true, "$ref": "GoogleRpcStatus", "description": "Output only. In case of an error, this field will be populated with a detailed error message for overall rewards to help with debugging." }, "rewardDetails": { "description": "Output only. Deprecated: Use reward_info_details instead. A map from reward name to the calculated reward for the reward function. This field will only be populated when a CompositeReinforcementTuningRewardConfig is provided in the request. It will not be set for a SingleReinforcementTuningRewardConfig.", "additionalProperties": { "type": "number", "format": "float" }, "deprecated": true, "type": "object", "readOnly": true }, "error": { "readOnly": true, "deprecated": true, "type": "string", "description": "Output only. Deprecated: Use error_status instead. In case of an error, this field will be populated with a detailed error message to help with debugging." }, "overallReward": { "format": "float", "type": "number", "description": "Output only. The overall weighted reward. For a CompositeReinforcementTuningRewardConfig, this is the weighted average of all rewards. For a SingleReinforcementTuningRewardConfig, this will be the value of the single reward.", "readOnly": true } }, "description": "Response message for GenAiTuningService.ValidateReinforcementTuningReward.", "id": "GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardResponse", "type": "object" }, "GenaiVertexV1beta1ToolCallContent": { "properties": { "mcpServerToolCall": { "$ref": "GenaiVertexV1beta1McpServerToolCallContent" }, "urlContextCall": { "$ref": "GenaiVertexV1beta1UrlContextCallContent" }, "id": { "type": "string", "description": "Required. A unique ID for this specific tool call." }, "googleMapsCall": { "$ref": "GenaiVertexV1beta1GoogleMapsCallContent" }, "googleSearchCall": { "$ref": "GenaiVertexV1beta1GoogleSearchCallContent" }, "functionCall": { "$ref": "GenaiVertexV1beta1FunctionCallContent" }, "signature": { "description": "A signature hash for backend validation.", "type": "string", "format": "byte" }, "codeExecutionCall": { "$ref": "GenaiVertexV1beta1CodeExecutionCallContent" }, "fileSearchCall": { "$ref": "GenaiVertexV1beta1FileSearchCallContent" } }, "type": "object", "deprecated": true, "id": "GenaiVertexV1beta1ToolCallContent", "description": "Tool call content." }, "GoogleCloudAiplatformV1beta1GdcConfig": { "description": "Google Distributed Cloud (GDC) config.", "id": "GoogleCloudAiplatformV1beta1GdcConfig", "properties": { "zone": { "type": "string", "description": "GDC zone. A cluster will be designated for the Vertex AI workload in this zone." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1PartialArg": { "id": "GoogleCloudAiplatformV1beta1PartialArg", "properties": { "willContinue": { "description": "Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow.", "type": "boolean" }, "numberValue": { "format": "double", "description": "Optional. Represents a double value.", "type": "number" }, "boolValue": { "description": "Optional. Represents a boolean value.", "type": "boolean" }, "jsonPath": { "type": "string", "description": "Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. \"$.foo.bar[0].data\"." }, "stringValue": { "description": "Optional. Represents a string value.", "type": "string" }, "nullValue": { "type": "string", "enum": [ "NULL_VALUE" ], "enumDescriptions": [ "Null value." ], "description": "Optional. Represents a null value." } }, "type": "object", "description": "Partial argument value of the function call." }, "GoogleCloudAiplatformV1beta1BatchReadFeatureValuesResponse": { "properties": {}, "description": "Response message for FeaturestoreService.BatchReadFeatureValues.", "type": "object", "id": "GoogleCloudAiplatformV1beta1BatchReadFeatureValuesResponse" }, "GoogleCloudAiplatformV1beta1ExpressProject": { "properties": { "projectNumber": { "type": "string", "readOnly": true, "format": "int64", "description": "Output only. The number of the project." }, "defaultApiKey": { "readOnly": true, "description": "Output only. The default API key string of the project.", "type": "string" }, "region": { "readOnly": true, "type": "string", "description": "Output only. The region of the project." }, "createTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. The time the project was created." }, "tier": { "readOnly": true, "enum": [ "TIER_UNSPECIFIED", "TIER_FREE", "TIER_PAID" ], "description": "Output only. The tier of the project.", "enumDescriptions": [ "Not specified.", "Free tier - initial tier for managed project.", "Paid tier is assigned to managed project after the upgrade." ], "type": "string" }, "projectId": { "type": "string", "description": "Output only. The ID of the project.", "readOnly": true } }, "description": "The project for Vertex AI Express Mode.", "type": "object", "id": "GoogleCloudAiplatformV1beta1ExpressProject" }, "GoogleCloudAiplatformV1beta1AnnotationSpec": { "description": "Identifies a concept with which DataItems may be annotated with.", "id": "GoogleCloudAiplatformV1beta1AnnotationSpec", "type": "object", "properties": { "name": { "readOnly": true, "description": "Output only. Resource name of the AnnotationSpec.", "type": "string" }, "updateTime": { "readOnly": true, "description": "Output only. Timestamp when AnnotationSpec was last updated.", "type": "string", "format": "google-datetime" }, "displayName": { "description": "Required. The user-defined name of the AnnotationSpec. The name can be up to 128 characters long and can consist of any UTF-8 characters.", "type": "string" }, "createTime": { "type": "string", "description": "Output only. Timestamp when this AnnotationSpec was created.", "readOnly": true, "format": "google-datetime" }, "etag": { "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1AddTrialMeasurementRequest": { "id": "GoogleCloudAiplatformV1beta1AddTrialMeasurementRequest", "description": "Request message for VizierService.AddTrialMeasurement.", "type": "object", "properties": { "measurement": { "$ref": "GoogleCloudAiplatformV1beta1Measurement", "description": "Required. The measurement to be added to a Trial." } } }, "GoogleCloudAiplatformV1beta1XprofConfig": { "description": "XprofConfig contains the configuration for managed XProf.", "type": "object", "properties": { "gcsBucketUri": { "description": "Required. User-owned Cloud Storage bucket (gs://) in the user project.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1XprofConfig" }, "GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadata": { "id": "GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadata", "type": "object", "description": "Runtime operation metadata with regard to Matching Engine Index.", "properties": { "contentValidationStats": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadataContentValidationStats" }, "description": "The validation stats of the content (per file) to be inserted or updated on the Matching Engine Index resource. Populated if contentsDeltaUri is provided as part of Index.metadata. Please note that, currently for those files that are broken or has unsupported file format, we will not have the stats for those files." }, "dataBytesCount": { "description": "The ingested data size in bytes.", "type": "string", "format": "int64" } } }, "GoogleCloudAiplatformV1beta1VertexAISearch": { "id": "GoogleCloudAiplatformV1beta1VertexAISearch", "type": "object", "properties": { "dataStoreSpecs": { "items": { "$ref": "GoogleCloudAiplatformV1beta1VertexAISearchDataStoreSpec" }, "description": "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.", "type": "array" }, "filter": { "type": "string", "description": "Optional. Filter strings to be passed to the search API." }, "engine": { "description": "Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "type": "string" }, "datastore": { "type": "string", "description": "Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`" }, "maxResults": { "format": "int32", "description": "Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.", "type": "integer" } }, "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" }, "GoogleCloudAiplatformV1beta1OnlineEvaluator": { "type": "object", "properties": { "metricSources": { "type": "array", "description": "Required. A list of metric sources to be used for evaluating samples. At least one MetricSource must be provided. Right now, only predefined metrics and registered metrics are supported. Every registered metric must have `display_name` (or `title`) and `score_range` defined. Otherwise, the evaluations will fail. The maximum number of `metric_sources` is 25.", "items": { "$ref": "GoogleCloudAiplatformV1beta1MetricSource" } }, "updateTime": { "description": "Output only. Timestamp when the OnlineEvaluator was last updated.", "format": "google-datetime", "type": "string", "readOnly": true }, "stateDetails": { "readOnly": true, "type": "array", "description": "Output only. Contains additional information about the state of the OnlineEvaluator. This is used to provide more details in the event of a failure.", "items": { "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorStateDetails" } }, "cloudObservability": { "description": "Data source for the OnlineEvaluator, based on Google Cloud Observability stack (Cloud Trace & Cloud Logging).", "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservability" }, "state": { "type": "string", "enumDescriptions": [ "Default value.", "Indicates that the OnlineEvaluator is active.", "Indicates that the OnlineEvaluator is suspended. In this state, the OnlineEvaluator will not evaluate any samples.", "Indicates that the OnlineEvaluator is in a failed state. This can happen if, for example, the `log_view` or `trace_view` set on the `CloudObservability` does not exist.", "Indicates that the OnlineEvaluator is in a warning state. This can happen if, for example, some of the metrics in the `metric_sources` are invalid. Evaluation will still run with the remaining valid metrics." ], "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "SUSPENDED", "FAILED", "WARNING" ], "description": "Output only. The state of the OnlineEvaluator.", "readOnly": true }, "createTime": { "description": "Output only. Timestamp when the OnlineEvaluator was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "name": { "type": "string", "description": "Identifier. The resource name of the OnlineEvaluator. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}." }, "config": { "description": "Required. Configuration for the OnlineEvaluator.", "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorConfig" }, "agentResource": { "type": "string", "description": "Required. Immutable. The name of the agent that the OnlineEvaluator evaluates periodically. This value is used to filter the traces with a matching cloud.resource_id and link the evaluation results with relevant dashboards/UIs. This field is immutable. Once set, it cannot be changed." }, "displayName": { "description": "Optional. Human-readable name for the OnlineEvaluator. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned.", "type": "string" } }, "description": "An OnlineEvaluator contains the configuration for an Online Evaluation.", "id": "GoogleCloudAiplatformV1beta1OnlineEvaluator" }, "GoogleCloudAiplatformV1beta1Event": { "description": "An edge describing the relationship between an Artifact and an Execution in a lineage graph.", "type": "object", "id": "GoogleCloudAiplatformV1beta1Event", "properties": { "eventTime": { "description": "Output only. Time the Event occurred.", "format": "google-datetime", "readOnly": true, "type": "string" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The labels with user-defined metadata to annotate Events. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Event (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable." }, "type": { "enum": [ "TYPE_UNSPECIFIED", "INPUT", "OUTPUT" ], "enumDescriptions": [ "Unspecified whether input or output of the Execution.", "An input of the Execution.", "An output of the Execution." ], "type": "string", "description": "Required. The type of the Event." }, "artifact": { "type": "string", "description": "Required. The relative resource name of the Artifact in the Event." }, "execution": { "type": "string", "readOnly": true, "description": "Output only. The relative resource name of the Execution in the Event." } } }, "GoogleCloudAiplatformV1beta1CandidateResponse": { "id": "GoogleCloudAiplatformV1beta1CandidateResponse", "type": "object", "properties": { "error": { "$ref": "GoogleRpcStatus", "readOnly": true, "description": "Output only. Error while scraping model or agent." }, "text": { "type": "string", "description": "Text response." }, "events": { "type": "array", "description": "Optional. Intermediate events (such as tool calls and responses) that led to the final response.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" } }, "candidate": { "description": "Required. The name of the candidate that produced the response.", "type": "string" }, "agentData": { "$ref": "GoogleCloudAiplatformV1beta1AgentData", "description": "Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation." }, "value": { "description": "Fields and values that can be used to populate the response template.", "type": "any" } }, "description": "Responses from model or agent." }, "GoogleCloudAiplatformV1beta1CancelTrainingPipelineRequest": { "id": "GoogleCloudAiplatformV1beta1CancelTrainingPipelineRequest", "description": "Request message for PipelineService.CancelTrainingPipeline.", "type": "object", "properties": {} }, "GoogleCloudAiplatformV1beta1TensorboardTensor": { "type": "object", "description": "One point viewable on a tensor metric plot.", "id": "GoogleCloudAiplatformV1beta1TensorboardTensor", "properties": { "value": { "description": "Required. Serialized form of https://github.com/tensorflow/tensorflow/blob/master/tensorflow/core/framework/tensor.proto", "format": "byte", "type": "string" }, "versionNumber": { "type": "integer", "format": "int32", "description": "Optional. Version number of TensorProto used to serialize value." } } }, "GoogleCloudAiplatformV1beta1EvaluateDatasetRun": { "description": "Evaluate Dataset Run Result for Tuning Job.", "id": "GoogleCloudAiplatformV1beta1EvaluateDatasetRun", "properties": { "operationName": { "type": "string", "readOnly": true, "deprecated": true, "description": "Output only. Deprecated: The updated architecture uses evaluation_run instead." }, "checkpointId": { "readOnly": true, "description": "Output only. The checkpoint id used in the evaluation run. Only populated when evaluating checkpoints.", "type": "string" }, "evaluationRun": { "type": "string", "description": "Output only. The resource name of the evaluation run. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run_id}`.", "readOnly": true }, "evaluateDatasetResponse": { "description": "Output only. Results for EvaluationService.", "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1EvaluateDatasetResponse" }, "error": { "$ref": "GoogleRpcStatus", "description": "Output only. The error of the evaluation run if any.", "readOnly": true } }, "type": "object" }, "GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingResult": { "id": "GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingResult", "description": "Result for RubricBasedInstructionFollowing metric.", "type": "object", "properties": { "rubricCritiqueResults": { "description": "Output only. List of per rubric critique results.", "type": "array", "readOnly": true, "items": { "$ref": "GoogleCloudAiplatformV1beta1RubricCritiqueResult" } }, "score": { "description": "Output only. Overall score for the instruction following.", "format": "float", "type": "number", "readOnly": true } } }, "GoogleCloudAiplatformV1beta1ToolNameMatchSpec": { "id": "GoogleCloudAiplatformV1beta1ToolNameMatchSpec", "description": "Spec for tool name match metric.", "properties": {}, "type": "object" }, "GoogleCloudAiplatformV1beta1BidiExecuteSandboxEnvironmentRequest": { "description": "Request message for SandboxEnvironmentExecutionService.BidiExecuteSandboxEnvironment.", "properties": { "inputs": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Chunk" }, "description": "Required. The inputs to the sandbox environment." } }, "id": "GoogleCloudAiplatformV1beta1BidiExecuteSandboxEnvironmentRequest", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionHierarchyConfig": { "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionHierarchyConfig", "properties": { "groupTemporalTotalWeight": { "description": "The weight of the loss for predictions aggregated over both the horizon and time series in the same hierarchy group.", "format": "double", "type": "number" }, "temporalTotalWeight": { "description": "The weight of the loss for predictions aggregated over the horizon for a single time series.", "type": "number", "format": "double" }, "groupColumns": { "items": { "type": "string" }, "description": "A list of time series attribute column names that define the time series hierarchy. Only one level of hierarchy is supported, ex. 'region' for a hierarchy of stores or 'department' for a hierarchy of products. If multiple columns are specified, time series will be grouped by their combined values, ex. ('blue', 'large') for 'color' and 'size', up to 5 columns are accepted. If no group columns are specified, all time series are considered to be part of the same group.", "type": "array" }, "groupTotalWeight": { "type": "number", "description": "The weight of the loss for predictions aggregated over time series in the same group.", "format": "double" } }, "description": "Configuration that defines the hierarchical relationship of time series and parameters for hierarchical forecasting strategies.", "type": "object" }, "GoogleCloudAiplatformV1beta1CandidateResult": { "id": "GoogleCloudAiplatformV1beta1CandidateResult", "type": "object", "description": "Result for a single candidate.", "properties": { "additionalResults": { "description": "Optional. Additional results for the metric.", "type": "any" }, "candidate": { "description": "Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest.", "type": "string" }, "error": { "readOnly": true, "$ref": "GoogleRpcStatus", "description": "Output only. Error while evaluating the candidate for the metric." }, "metric": { "description": "Required. The metric that was evaluated.", "type": "string" }, "explanation": { "type": "string", "description": "Optional. The explanation for the metric." }, "rubricVerdicts": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1RubricVerdict" }, "description": "Optional. The rubric verdicts for the metric." }, "score": { "format": "float", "type": "number", "description": "Optional. The score for the metric." } } }, "GoogleCloudAiplatformV1beta1ComputationBasedMetricSpec": { "type": "object", "properties": { "parameters": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "Optional. A map of parameters for the metric, e.g. {\"rouge_type\": \"rougeL\"}." }, "type": { "enum": [ "COMPUTATION_BASED_METRIC_TYPE_UNSPECIFIED", "EXACT_MATCH", "BLEU", "ROUGE" ], "type": "string", "enumDescriptions": [ "Unspecified computation based metric type.", "Exact match metric.", "BLEU metric.", "ROUGE metric." ], "description": "Required. The type of the computation based metric." } }, "description": "Specification for a computation based metric.", "id": "GoogleCloudAiplatformV1beta1ComputationBasedMetricSpec" }, "GoogleCloudAiplatformV1beta1LineageSubgraph": { "type": "object", "properties": { "artifacts": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Artifact" }, "type": "array", "description": "The Artifact nodes in the subgraph." }, "events": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Event" }, "description": "The Event edges between Artifacts and Executions in the subgraph." }, "executions": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Execution" }, "description": "The Execution nodes in the subgraph." } }, "description": "A subgraph of the overall lineage graph. Event edges connect Artifact and Execution nodes.", "id": "GoogleCloudAiplatformV1beta1LineageSubgraph" }, "GoogleCloudAiplatformV1beta1EvaluateDatasetResponse": { "description": "The results from an evaluation run performed by the EvaluationService.", "properties": { "aggregationOutput": { "$ref": "GoogleCloudAiplatformV1beta1AggregationOutput", "readOnly": true, "description": "Output only. Aggregation statistics derived from results of EvaluationService." }, "outputInfo": { "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1OutputInfo", "description": "Output only. Output info for EvaluationService." } }, "id": "GoogleCloudAiplatformV1beta1EvaluateDatasetResponse", "type": "object" }, "GoogleCloudAiplatformV1beta1NearestNeighborQueryEmbedding": { "id": "GoogleCloudAiplatformV1beta1NearestNeighborQueryEmbedding", "properties": { "value": { "description": "Optional. Individual value in the embedding.", "items": { "type": "number", "format": "float" }, "type": "array" } }, "description": "The embedding vector.", "type": "object" }, "GoogleCloudAiplatformV1beta1MutateDeployedModelResponse": { "id": "GoogleCloudAiplatformV1beta1MutateDeployedModelResponse", "description": "Response message for EndpointService.MutateDeployedModel.", "properties": { "deployedModel": { "$ref": "GoogleCloudAiplatformV1beta1DeployedModel", "description": "The DeployedModel that's being mutated." } }, "type": "object" }, "GenaiVertexV1beta1ListValue": { "description": "`ListValue` is a wrapper around a repeated field of values.", "properties": { "values": { "description": "Repeated field of dynamically typed values.", "items": { "$ref": "GenaiVertexV1beta1Value" }, "type": "array" } }, "type": "object", "id": "GenaiVertexV1beta1ListValue" }, "GoogleCloudAiplatformV1beta1A2ATaskRecordArtifact": { "id": "GoogleCloudAiplatformV1beta1A2ATaskRecordArtifact", "properties": { "displayName": { "type": "string", "description": "Optional. The human-readable name of the artifact." }, "description": { "description": "Optional. A human-readable description of the artifact.", "type": "string" }, "parts": { "items": { "$ref": "GoogleCloudAiplatformV1beta1A2APart" }, "type": "array", "description": "Required. The content parts that make up the artifact." }, "extensions": { "type": "array", "items": { "type": "string" }, "description": "Optional. A2A protocol extensions associated with the artifact." }, "artifactId": { "type": "string", "description": "Required. The unique identifier of the artifact within the task." }, "metadata": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional. Additional context or parameters related to the artifact. Extensions can be used to strongly type metadata values for specific use cases.", "type": "object" } }, "description": "Represents a single artifact produced by a task.", "type": "object" }, "GoogleCloudAiplatformV1beta1ProbeHttpHeader": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ProbeHttpHeader", "properties": { "name": { "description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.", "type": "string" }, "value": { "description": "The header field value", "type": "string" } }, "description": "HttpHeader describes a custom header to be used in HTTP probes" }, "GoogleCloudAiplatformV1beta1SchemaVideoClassificationAnnotation": { "type": "object", "description": "Annotation details specific to video classification.", "id": "GoogleCloudAiplatformV1beta1SchemaVideoClassificationAnnotation", "properties": { "timeSegment": { "description": "This Annotation applies to the time period represented by the TimeSegment. If it's not set, the Annotation applies to the whole video.", "$ref": "GoogleCloudAiplatformV1beta1SchemaTimeSegment" }, "displayName": { "description": "The display name of the AnnotationSpec that this Annotation pertains to.", "type": "string" }, "annotationSpecId": { "type": "string", "description": "The resource Id of the AnnotationSpec that this Annotation pertains to." } } }, "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponseHeader": { "id": "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponseHeader", "properties": { "featureDescriptors": { "items": { "$ref": "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponseFeatureDescriptor" }, "description": "List of Feature metadata corresponding to each piece of ReadFeatureValuesResponse.EntityView.data.", "type": "array" }, "entityType": { "description": "The resource name of the EntityType from the ReadFeatureValuesRequest. Value format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`.", "type": "string" } }, "description": "Response header with metadata for the requested ReadFeatureValuesRequest.entity_type and Features.", "type": "object" }, "GoogleCloudAiplatformV1beta1FunctionResponseFileData": { "description": "URI based data for function response.", "type": "object", "properties": { "mimeType": { "description": "Required. The IANA standard MIME type of the source data.", "type": "string" }, "fileUri": { "description": "Required. URI.", "type": "string" }, "displayName": { "description": "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.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1FunctionResponseFileData" }, "GoogleCloudAiplatformV1beta1LogprobsResultCandidate": { "id": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate", "type": "object", "properties": { "token": { "type": "string", "description": "The token's string representation." }, "logProbability": { "description": "The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain.", "type": "number", "format": "float" }, "tokenId": { "type": "integer", "format": "int32", "description": "The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary." } }, "description": "A single token and its associated log probability." }, "GoogleCloudAiplatformV1beta1BatchCancelPipelineJobsResponse": { "id": "GoogleCloudAiplatformV1beta1BatchCancelPipelineJobsResponse", "description": "Response message for PipelineService.BatchCancelPipelineJobs.", "properties": { "pipelineJobs": { "description": "PipelineJobs cancelled.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1PipelineJob" } } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ToolExaAiSearch": { "properties": { "apiKey": { "description": "Required. The API key for ExaAiSearch.", "type": "string" }, "customConfigs": { "description": "Optional. This field can be used to pass any parameter from the Exa.ai Search API.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" } }, "id": "GoogleCloudAiplatformV1beta1ToolExaAiSearch", "type": "object", "description": "ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding." }, "GoogleCloudAiplatformV1beta1BatchReadFeatureValuesRequestPassThroughField": { "description": "Describe pass-through fields in read_instance source.", "type": "object", "properties": { "fieldName": { "description": "Required. The name of the field in the CSV header or the name of the column in BigQuery table. The naming restriction is the same as Feature.name.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1BatchReadFeatureValuesRequestPassThroughField" }, "GoogleCloudAiplatformV1beta1SamplingStrategyRandomSampleConfig": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SamplingStrategyRandomSampleConfig", "description": "Requests are randomly selected.", "properties": { "sampleRate": { "description": "Sample rate (0, 1]", "format": "double", "type": "number" } } }, "GoogleCloudAiplatformV1beta1ContainerSpec": { "id": "GoogleCloudAiplatformV1beta1ContainerSpec", "type": "object", "properties": { "imageUri": { "description": "Required. The URI of a container image in the Container Registry that is to be run on each worker replica.", "type": "string" }, "env": { "items": { "$ref": "GoogleCloudAiplatformV1beta1EnvVar" }, "description": "Environment variables to be passed to the container. Maximum limit is 100.", "type": "array" }, "command": { "type": "array", "items": { "type": "string" }, "description": "The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided." }, "args": { "description": "The arguments to be passed when starting the container.", "type": "array", "items": { "type": "string" } } }, "description": "The spec of a Container." }, "GenaiVertexV1beta1RetrievalCallStep": { "type": "object", "properties": { "arguments": { "description": "Required. The arguments to pass to the retrieval tool.", "$ref": "GenaiVertexV1beta1RetrievalCallStepRetrievalStepArguments" }, "retrievalType": { "type": "string", "enum": [ "RETRIEVAL_TYPE_UNSPECIFIED", "RETRIEVAL_TYPE_VERTEX_AI_SEARCH", "RETRIEVAL_TYPE_RAG_STORE", "RETRIEVAL_TYPE_EXA_AI_SEARCH", "RETRIEVAL_TYPE_PARALLEL_AI_SEARCH" ], "enumDescriptions": [ "", "", "", "", "" ], "description": "The type of retrieval tools." } }, "id": "GenaiVertexV1beta1RetrievalCallStep", "description": "Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used." }, "GoogleCloudAiplatformV1beta1FeatureOnlineStore": { "description": "Vertex AI Feature Online Store provides a centralized repository for serving ML features and embedding indexes at low latency. The Feature Online Store is a top-level container.", "properties": { "createTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. Timestamp when this FeatureOnlineStore was created." }, "etag": { "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "type": "string" }, "bigtable": { "description": "Contains settings for the Cloud Bigtable instance that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore.", "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreBigtable" }, "dedicatedServingEndpoint": { "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreDedicatedServingEndpoint", "description": "Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint." }, "satisfiesPzs": { "readOnly": true, "type": "boolean", "description": "Output only. Reserved for future use." }, "encryptionSpec": { "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec", "description": "Optional. Customer-managed encryption key spec for data storage. If set, online store will be secured by this key." }, "name": { "type": "string", "description": "Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`" }, "optimized": { "description": "Contains settings for the Optimized store that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore. When choose Optimized storage type, need to set PrivateServiceConnectConfig.enable_private_service_connect to use private endpoint. Otherwise will use public endpoint by default.", "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreOptimized" }, "satisfiesPzi": { "readOnly": true, "type": "boolean", "description": "Output only. Reserved for future use." }, "updateTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp when this FeatureOnlineStore was last updated.", "type": "string" }, "state": { "type": "string", "readOnly": true, "description": "Output only. State of the featureOnlineStore.", "enumDescriptions": [ "Default value. This value is unused.", "State when the featureOnlineStore configuration is not being updated and the fields reflect the current configuration of the featureOnlineStore. The featureOnlineStore is usable in this state.", "The state of the featureOnlineStore configuration when it is being updated. During an update, the fields reflect either the original configuration or the updated configuration of the featureOnlineStore. The featureOnlineStore is still usable in this state." ], "enum": [ "STATE_UNSPECIFIED", "STABLE", "UPDATING" ] }, "embeddingManagement": { "deprecated": true, "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreEmbeddingManagement", "description": "Optional. Deprecated: This field is no longer needed anymore and embedding management is automatically enabled when specifying Optimized storage type." }, "labels": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Optional. The labels with user-defined metadata to organize your FeatureOnlineStore. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureOnlineStore(System labels are excluded).\" System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1FeatureOnlineStore" }, "GoogleCloudAiplatformV1beta1ExportFractionSplit": { "properties": { "validationFraction": { "type": "number", "description": "The fraction of the input data that is to be used to validate the Model.", "format": "double" }, "trainingFraction": { "type": "number", "format": "double", "description": "The fraction of the input data that is to be used to train the Model." }, "testFraction": { "type": "number", "format": "double", "description": "The fraction of the input data that is to be used to evaluate the Model." } }, "description": "Assigns the input data to training, validation, and test sets as per the given fractions. Any of `training_fraction`, `validation_fraction` and `test_fraction` may optionally be provided, they must sum to up to 1. If the provided ones sum to less than 1, the remainder is assigned to sets as decided by Vertex AI. If none of the fractions are set, by default roughly 80% of data is used for training, 10% for validation, and 10% for test.", "type": "object", "id": "GoogleCloudAiplatformV1beta1ExportFractionSplit" }, "GoogleCloudAiplatformV1beta1ImportDataResponse": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ImportDataResponse", "properties": {}, "description": "Response message for DatasetService.ImportData." }, "GoogleCloudAiplatformV1beta1LLMBasedMetricSpec": { "description": "Specification for an LLM based metric.", "id": "GoogleCloudAiplatformV1beta1LLMBasedMetricSpec", "properties": { "predefinedRubricGenerationSpec": { "$ref": "GoogleCloudAiplatformV1beta1PredefinedMetricSpec", "description": "Dynamically generate rubrics using a predefined spec." }, "metricPromptTemplate": { "type": "string", "description": "Required. Template for the prompt sent to the judge model." }, "judgeAutoraterConfig": { "description": "Optional. Optional configuration for the judge LLM (Autorater).", "$ref": "GoogleCloudAiplatformV1beta1AutoraterConfig" }, "additionalConfig": { "description": "Optional. Optional additional configuration for the metric.", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "systemInstruction": { "description": "Optional. System instructions for the judge model.", "type": "string" }, "rubricGroupKey": { "description": "Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.", "type": "string" }, "resultParserConfig": { "description": "Optional. The parser config for the metric result.", "$ref": "GoogleCloudAiplatformV1beta1EvaluationParserConfig" }, "rubricGenerationSpec": { "description": "Dynamically generate rubrics using this specification.", "$ref": "GoogleCloudAiplatformV1beta1RubricGenerationSpec" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1WriteTensorboardExperimentDataRequest": { "properties": { "writeRunDataRequests": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardRunDataRequest" }, "description": "Required. Requests containing per-run TensorboardTimeSeries data to write." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1WriteTensorboardExperimentDataRequest", "description": "Request message for TensorboardService.WriteTensorboardExperimentData." }, "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode": { "properties": { "modelName": { "description": "The name of the model to use. Only public LLM models are accepted.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode", "description": "The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided.", "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext": { "description": "Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext", "properties": { "title": { "type": "string", "description": "The title of the retrieved data source." }, "text": { "description": "The content of the retrieved data source.", "type": "string" }, "uri": { "description": "The URI of the retrieved data source.", "type": "string" }, "ragChunk": { "description": "Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used.", "$ref": "GoogleCloudAiplatformV1beta1RagChunk" }, "documentName": { "readOnly": true, "description": "Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1AuthConfigOauthConfig": { "properties": { "accessToken": { "type": "string", "description": "Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time." }, "serviceAccount": { "description": "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.", "type": "string" } }, "description": "Config for user oauth.", "id": "GoogleCloudAiplatformV1beta1AuthConfigOauthConfig", "type": "object" }, "GoogleCloudAiplatformV1beta1DatasetDistribution": { "description": "Distribution computed over a tuning dataset.", "id": "GoogleCloudAiplatformV1beta1DatasetDistribution", "type": "object", "properties": { "median": { "description": "Output only. The median of the values in the population.", "type": "number", "format": "double", "readOnly": true }, "max": { "description": "Output only. The maximum of the population values.", "readOnly": true, "type": "number", "format": "double" }, "min": { "readOnly": true, "description": "Output only. The minimum of the population values.", "type": "number", "format": "double" }, "p5": { "readOnly": true, "description": "Output only. The 5th percentile of the values in the population.", "format": "double", "type": "number" }, "sum": { "format": "double", "type": "number", "readOnly": true, "description": "Output only. Sum of a given population of values." }, "buckets": { "description": "Output only. Defines the histogram bucket.", "items": { "$ref": "GoogleCloudAiplatformV1beta1DatasetDistributionDistributionBucket" }, "type": "array", "readOnly": true }, "mean": { "format": "double", "readOnly": true, "type": "number", "description": "Output only. The arithmetic mean of the values in the population." }, "p95": { "format": "double", "readOnly": true, "type": "number", "description": "Output only. The 95th percentile of the values in the population." } } }, "GoogleCloudAiplatformV1beta1DeployModelRequest": { "properties": { "deployedModel": { "description": "Required. The DeployedModel to be created within the Endpoint. Note that Endpoint.traffic_split must be updated for the DeployedModel to start receiving traffic, either as part of this call, or via EndpointService.UpdateEndpoint.", "$ref": "GoogleCloudAiplatformV1beta1DeployedModel" }, "trafficSplit": { "additionalProperties": { "type": "integer", "format": "int32" }, "type": "object", "description": "A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If this field is non-empty, then the Endpoint's traffic_split will be overwritten with it. To refer to the ID of the just being deployed Model, a \"0\" should be used, and the actual ID of the new DeployedModel will be filled in its place by this method. The traffic percentage values must add up to 100. If this field is empty, then the Endpoint's traffic_split is not updated." } }, "id": "GoogleCloudAiplatformV1beta1DeployModelRequest", "type": "object", "description": "Request message for EndpointService.DeployModel." }, "GoogleCloudAiplatformV1beta1ModelEvaluationBiasConfig": { "description": "Configuration for bias detection.", "properties": { "labels": { "type": "array", "items": { "type": "string" }, "description": "Positive labels selection on the target field." }, "biasSlices": { "$ref": "GoogleCloudAiplatformV1beta1ModelEvaluationSliceSliceSliceSpec", "description": "Specification for how the data should be sliced for bias. It contains a list of slices, with limitation of two slices. The first slice of data will be the slice_a. The second slice in the list (slice_b) will be compared against the first slice. If only a single slice is provided, then slice_a will be compared against \"not slice_a\". Below are examples with feature \"education\" with value \"low\", \"medium\", \"high\" in the dataset: Example 1: bias_slices = [{'education': 'low'}] A single slice provided. In this case, slice_a is the collection of data with 'education' equals 'low', and slice_b is the collection of data with 'education' equals 'medium' or 'high'. Example 2: bias_slices = [{'education': 'low'}, {'education': 'high'}] Two slices provided. In this case, slice_a is the collection of data with 'education' equals 'low', and slice_b is the collection of data with 'education' equals 'high'." } }, "id": "GoogleCloudAiplatformV1beta1ModelEvaluationBiasConfig", "type": "object" }, "GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates": { "description": "A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered.", "properties": { "candidates": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate" }, "description": "The list of candidate tokens, sorted by log probability in descending order." } }, "id": "GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates", "type": "object" }, "GenaiVertexV1beta1GoogleSearchCallDelta": { "properties": { "arguments": { "$ref": "GenaiVertexV1beta1GoogleSearchCallContentGoogleSearchCallArguments" } }, "type": "object", "id": "GenaiVertexV1beta1GoogleSearchCallDelta" }, "GoogleCloudAiplatformV1beta1ListArtifactsResponse": { "id": "GoogleCloudAiplatformV1beta1ListArtifactsResponse", "description": "Response message for MetadataService.ListArtifacts.", "properties": { "nextPageToken": { "type": "string", "description": "A token, which can be sent as ListArtifactsRequest.page_token to retrieve the next page. If this field is not populated, there are no subsequent pages." }, "artifacts": { "description": "The Artifacts retrieved from the MetadataStore.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Artifact" }, "type": "array" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaImageSegmentationAnnotationMaskAnnotation": { "id": "GoogleCloudAiplatformV1beta1SchemaImageSegmentationAnnotationMaskAnnotation", "type": "object", "properties": { "maskGcsUri": { "description": "Google Cloud Storage URI that points to the mask image. The image must be in PNG format. It must have the same size as the DataItem's image. Each pixel in the image mask represents the AnnotationSpec which the pixel in the image DataItem belong to. Each color is mapped to one AnnotationSpec based on annotation_spec_colors.", "type": "string" }, "annotationSpecColors": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaAnnotationSpecColor" }, "description": "The mapping between color and AnnotationSpec for this Annotation." } }, "description": "The mask based segmentation annotation." }, "GoogleCloudAiplatformV1beta1AuthorizeSandboxEnvironmentAccessResponse": { "description": "Response message for SandboxEnvironmentExecutionService.AuthorizeSandboxEnvironmentAccess. Intentionally empty: a successful response is the authorization result.", "id": "GoogleCloudAiplatformV1beta1AuthorizeSandboxEnvironmentAccessResponse", "type": "object", "properties": {} }, "GoogleCloudAiplatformV1beta1QuestionAnsweringCorrectnessInstance": { "properties": { "prediction": { "description": "Required. Output of the evaluated model.", "type": "string" }, "context": { "type": "string", "description": "Optional. Text provided as context to answer the question." }, "reference": { "description": "Optional. Ground truth used to compare against the prediction.", "type": "string" }, "instruction": { "type": "string", "description": "Required. The question asked and other instruction in the inference prompt." } }, "description": "Spec for question answering correctness instance.", "id": "GoogleCloudAiplatformV1beta1QuestionAnsweringCorrectnessInstance", "type": "object" }, "GoogleCloudAiplatformV1beta1ExecuteExtensionResponse": { "type": "object", "description": "Response message for ExtensionExecutionService.ExecuteExtension.", "id": "GoogleCloudAiplatformV1beta1ExecuteExtensionResponse", "properties": { "content": { "type": "string", "description": "Response content from the extension. The content should be conformant to the response.content schema in the extension's manifest/OpenAPI spec." } } }, "CloudAiLargeModelsVisionGenerateVideoRequestAudio": { "description": "The raw bytes or Cloud Storage URI for an audio input.", "type": "object", "properties": { "bytesBase64Encoded": { "description": "Base64 encoded bytes string representing the audio.", "type": "string" }, "blobId": { "description": "Blob ID of the audio. This is used for storing the large audio in the request.", "type": "string" }, "mimeType": { "description": "The MIME type of the content of the audio. Only audio in below listed MIME types are supported. - audio/wav - audio/mp3 - audio/mpeg", "type": "string" }, "gcsUri": { "type": "string" } }, "id": "CloudAiLargeModelsVisionGenerateVideoRequestAudio" }, "GoogleCloudAiplatformV1beta1GroundingMetadata": { "id": "GoogleCloudAiplatformV1beta1GroundingMetadata", "type": "object", "properties": { "sourceFlaggingUris": { "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri" }, "description": "Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps." }, "groundingChunks": { "type": "array", "description": "A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.", "items": { "$ref": "GoogleCloudAiplatformV1beta1GroundingChunk" } }, "retrievalQueries": { "description": "Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search.", "type": "array", "items": { "type": "string" } }, "searchEntryPoint": { "$ref": "GoogleCloudAiplatformV1beta1SearchEntryPoint", "description": "Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search." }, "retrievalMetadata": { "$ref": "GoogleCloudAiplatformV1beta1RetrievalMetadata", "readOnly": true, "description": "Optional. Output only. Metadata related to the retrieval grounding source." }, "groundingSupports": { "type": "array", "description": "Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search.", "items": { "$ref": "GoogleCloudAiplatformV1beta1GroundingSupport" } }, "googleMapsWidgetContextToken": { "type": "string", "description": "Optional. Output only. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and will no longer be populated once removed. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps.", "deprecated": true, "readOnly": true }, "webSearchQueries": { "description": "Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search.", "items": { "type": "string" }, "type": "array" }, "imageSearchQueries": { "type": "array", "description": "Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled.", "items": { "type": "string" } } }, "description": "Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources." }, "GoogleCloudAiplatformV1beta1WriteTensorboardRunDataResponse": { "type": "object", "id": "GoogleCloudAiplatformV1beta1WriteTensorboardRunDataResponse", "properties": {}, "description": "Response message for TensorboardService.WriteTensorboardRunData." }, "GenaiVertexV1beta1UrlContextCallDelta": { "properties": { "arguments": { "$ref": "GenaiVertexV1beta1UrlContextCallContentUrlContextCallArguments" } }, "id": "GenaiVertexV1beta1UrlContextCallDelta", "type": "object" }, "GoogleCloudAiplatformV1beta1CoherenceSpec": { "id": "GoogleCloudAiplatformV1beta1CoherenceSpec", "type": "object", "properties": { "version": { "description": "Optional. Which version to use for evaluation.", "format": "int32", "type": "integer" } }, "description": "Spec for coherence score metric." }, "GoogleCloudAiplatformV1beta1StreamQueryReasoningEngineRequest": { "description": "Request message for ReasoningEngineExecutionService.StreamQueryReasoningEngine.", "id": "GoogleCloudAiplatformV1beta1StreamQueryReasoningEngineRequest", "type": "object", "properties": { "input": { "type": "object", "description": "Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "classMethod": { "description": "Optional. Class method to be used for the stream query. It is optional and defaults to \"stream_query\" if unspecified.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1ReportExecutionEventResponse": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ReportExecutionEventResponse", "description": "Response message for NotebookInternalService.ReportExecutionEvent.", "properties": {} }, "GenaiVertexV1beta1ToolChoiceConfig": { "description": "The tool choice configuration containing allowed tools.", "properties": { "allowedTools": { "description": "The allowed tools.", "$ref": "GenaiVertexV1beta1AllowedTools" } }, "type": "object", "id": "GenaiVertexV1beta1ToolChoiceConfig" }, "GenaiVertexV1beta1AgentInteraction": { "description": "Interaction for generating the completion using agents.", "id": "GenaiVertexV1beta1AgentInteraction", "properties": { "agent": { "type": "string", "description": "The name of the `Agent` used for generating the completion." }, "dynamicConfig": { "$ref": "GenaiVertexV1beta1DynamicAgentConfig" }, "deepResearchConfig": { "$ref": "GenaiVertexV1beta1DeepResearchAgentConfig" }, "antigravityConfig": { "description": "Antigravity agent configuration. This configuration is session-level settings that are passed to the agent runtime on a per-request basis.", "$ref": "GenaiVertexV1beta1AntigravityAgentConfig" }, "codeMenderConfig": { "$ref": "GenaiVertexV1beta1CodeMenderAgentConfig" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1UpsertExamplesResponse": { "description": "Response message for ExampleStoreService.UpsertExamples.", "type": "object", "id": "GoogleCloudAiplatformV1beta1UpsertExamplesResponse", "properties": { "results": { "description": "A list of results for creating/updating. It's either a successfully created/updated example or a status with an error message.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1UpsertExamplesResponseUpsertResult" } } } }, "GoogleCloudAiplatformV1beta1ListNotebookExecutionJobsResponse": { "id": "GoogleCloudAiplatformV1beta1ListNotebookExecutionJobsResponse", "type": "object", "properties": { "notebookExecutionJobs": { "items": { "$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJob" }, "type": "array", "description": "List of NotebookExecutionJobs in the requested page." }, "nextPageToken": { "type": "string", "description": "A token to retrieve next page of results. Pass to ListNotebookExecutionJobsRequest.page_token to obtain that page." } }, "description": "Response message for [NotebookService.CreateNotebookExecutionJob]" }, "GoogleCloudAiplatformV1beta1TrajectoryAnyOrderMatchMetricValue": { "properties": { "score": { "format": "float", "description": "Output only. TrajectoryAnyOrderMatch score.", "type": "number", "readOnly": true } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1TrajectoryAnyOrderMatchMetricValue", "description": "TrajectoryAnyOrderMatch metric value for an instance." }, "GoogleCloudAiplatformV1beta1DatasetStats": { "id": "GoogleCloudAiplatformV1beta1DatasetStats", "properties": { "userMessagePerExampleDistribution": { "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1DatasetDistribution", "description": "Output only. Dataset distributions for the messages per example." }, "totalBillableTokenCount": { "format": "int64", "description": "Output only. Number of billable tokens in the tuning dataset.", "type": "string", "readOnly": true }, "userInputTokenDistribution": { "$ref": "GoogleCloudAiplatformV1beta1DatasetDistribution", "readOnly": true, "description": "Output only. Dataset distributions for the user input tokens." }, "reinforcementTuningUserDatasetExamples": { "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningUserDatasetExamples", "description": "Output only. Sample user dataset examples in the training dataset uri for Reinforcement Tuning.", "readOnly": true }, "tuningDatasetExampleCount": { "readOnly": true, "type": "string", "format": "int64", "description": "Output only. Number of examples in the tuning dataset." }, "tuningStepCount": { "description": "Output only. Number of tuning steps for this Tuning Job.", "type": "string", "readOnly": true, "format": "int64" }, "userDatasetExamples": { "type": "array", "description": "Output only. Sample user messages in the training dataset uri.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" }, "readOnly": true }, "droppedExampleReasons": { "type": "array", "items": { "type": "string" }, "description": "Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.", "readOnly": true }, "contentsPerExampleDistribution": { "$ref": "GoogleCloudAiplatformV1beta1DatasetDistribution", "readOnly": true, "description": "Output only. Dataset distributions for the number of contents per example." }, "totalTuningCharacterCount": { "format": "int64", "readOnly": true, "type": "string", "description": "Output only. Number of tuning characters in the tuning dataset." }, "droppedExampleIndices": { "readOnly": true, "type": "array", "items": { "format": "int64", "type": "string" }, "description": "Output only. A partial sample of the indices (starting from 1) of the dropped examples." }, "userOutputTokenDistribution": { "$ref": "GoogleCloudAiplatformV1beta1DatasetDistribution", "description": "Output only. Dataset distributions for the user output tokens.", "readOnly": true }, "totalBillableCharacterCount": { "type": "string", "readOnly": true, "format": "int64", "description": "Output only. Number of billable characters in the tuning dataset." } }, "type": "object", "description": "Statistics computed over a tuning dataset." }, "GenaiVertexV1beta1AudioDelta": { "type": "object", "id": "GenaiVertexV1beta1AudioDelta", "properties": { "data": { "type": "string", "format": "byte" }, "channels": { "description": "The number of audio channels.", "type": "integer", "format": "int32" }, "rate": { "description": "Deprecated. Use sample_rate instead. The value is ignored.", "type": "integer", "format": "int32", "deprecated": true }, "sampleRate": { "type": "integer", "format": "int32", "description": "The sample rate of the audio." }, "mimeType": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "TYPE_WAV", "TYPE_MP3", "TYPE_AIFF", "TYPE_AAC", "TYPE_OGG", "TYPE_FLAC", "TYPE_MPEG", "TYPE_M4A", "TYPE_L16", "TYPE_OPUS", "TYPE_ALAW", "TYPE_MULAW" ], "enumDescriptions": [ "", "WAV audio format", "MP3 audio format", "AIFF audio format", "AAC audio format", "OGG audio format", "FLAC audio format", "MPEG audio format", "M4A audio format", "L16 audio format", "OPUS audio format", "ALAW audio format", "MULAW audio format" ] }, "uri": { "type": "string" } } }, "GoogleCloudAiplatformV1beta1MemoryTopicId": { "id": "GoogleCloudAiplatformV1beta1MemoryTopicId", "type": "object", "description": "A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.", "properties": { "managedMemoryTopic": { "enumDescriptions": [ "Represents an unspecified topic. This value should not be used.", "Represents significant personal information about the User like first names, relationships, hobbies, important dates.", "Represents stated or implied likes, dislikes, preferred styles, or patterns.", "Represents important milestones or conclusions within the dialogue.", "Represents information that the user explicitly requested to remember or forget." ], "enum": [ "MANAGED_TOPIC_ENUM_UNSPECIFIED", "USER_PERSONAL_INFO", "USER_PREFERENCES", "KEY_CONVERSATION_DETAILS", "EXPLICIT_INSTRUCTIONS" ], "description": "Optional. Represents the managed memory topic.", "type": "string" }, "customMemoryTopicLabel": { "type": "string", "description": "Optional. Represents the custom memory topic label." } } }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata": { "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata", "type": "object", "properties": { "costMilliNodeHours": { "description": "The actual training cost of creating this model, expressed in milli node hours, i.e. 1,000 value in this field means 1 node hour. Guaranteed to not exceed inputs.budgetMilliNodeHours.", "type": "string", "format": "int64" }, "successfulStopReason": { "enumDescriptions": [ "Should not be set.", "The inputs.budgetMilliNodeHours had been reached.", "Further training of the Model ceased to increase its quality, since it already has converged." ], "description": "For successful job completions, this is the reason why the job has finished.", "type": "string", "enum": [ "SUCCESSFUL_STOP_REASON_UNSPECIFIED", "BUDGET_REACHED", "MODEL_CONVERGED" ] } } }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecasting": { "description": "A TrainingJob that trains and uploads an AutoML Forecasting Model.", "properties": { "inputs": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs", "description": "The input parameters of this TrainingJob." }, "metadata": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata", "description": "The metadata information." } }, "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecasting", "type": "object" }, "GoogleCloudAiplatformV1beta1IndexDatapointCrowdingTag": { "id": "GoogleCloudAiplatformV1beta1IndexDatapointCrowdingTag", "description": "Crowding tag is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than some value k' of the k neighbors returned have the same value of crowding_attribute.", "type": "object", "properties": { "crowdingAttribute": { "description": "The attribute value used for crowding. The maximum number of neighbors to return per crowding attribute value (per_crowding_attribute_num_neighbors) is configured per-query. This field is ignored if per_crowding_attribute_num_neighbors is larger than the total number of neighbors to return for a given query.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1FetchExamplesResponse": { "id": "GoogleCloudAiplatformV1beta1FetchExamplesResponse", "description": "Response message for ExampleStoreService.FetchExamples.", "properties": { "nextPageToken": { "description": "A token, which can be sent as FetchExamplesRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", "type": "string" }, "examples": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Example" }, "type": "array", "description": "The examples in the Example Store that satisfy the metadata filters." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ModelMonitoringSpec": { "id": "GoogleCloudAiplatformV1beta1ModelMonitoringSpec", "properties": { "objectiveSpec": { "description": "The monitoring objective spec.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveSpec" }, "outputSpec": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringOutputSpec", "description": "The Output destination spec for metrics, error logs, etc." }, "notificationSpec": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringNotificationSpec", "description": "The model monitoring notification spec." } }, "type": "object", "description": "Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports." }, "GoogleCloudAiplatformV1beta1BleuInstance": { "description": "Spec for bleu instance.", "type": "object", "properties": { "prediction": { "type": "string", "description": "Required. Output of the evaluated model." }, "reference": { "description": "Required. Ground truth used to compare against the prediction.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1BleuInstance" }, "GoogleApiHttpBody": { "properties": { "contentType": { "description": "The HTTP Content-Type header value specifying the content type of the body.", "type": "string" }, "extensions": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "description": "Application specific response metadata. Must be set in the first response for streaming APIs." }, "data": { "type": "string", "description": "The HTTP request/response body as raw binary.", "format": "byte" } }, "type": "object", "description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", "id": "GoogleApiHttpBody" }, "GoogleCloudAiplatformV1beta1CancelCustomJobRequest": { "type": "object", "description": "Request message for JobService.CancelCustomJob.", "properties": {}, "id": "GoogleCloudAiplatformV1beta1CancelCustomJobRequest" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs", "properties": { "multiLabel": { "description": "If false, a single-label (multi-class) Model will be trained (i.e. assuming that for each image just up to one annotation may be applicable). If true, a multi-label Model will be trained (i.e. assuming that for each image multiple annotations may be applicable).", "type": "boolean" }, "budgetMilliNodeHours": { "description": "The training budget of creating this model, expressed in milli node hours i.e. 1,000 value in this field means 1 node hour. The actual metadata.costMilliNodeHours will be equal or less than this value. If further model training ceases to provide any improvements, it will stop without using the full budget and the metadata.successfulStopReason will be `model-converged`. Note, node_hour = actual_hour * number_of_nodes_involved. For modelType `cloud`(default), the budget must be between 8,000 and 800,000 milli node hours, inclusive. The default value is 192,000 which represents one day in wall time, considering 8 nodes are used. For model types `mobile-tf-low-latency-1`, `mobile-tf-versatile-1`, `mobile-tf-high-accuracy-1`, the training budget must be between 1,000 and 100,000 milli node hours, inclusive. The default value is 24,000 which represents one day in wall time on a single node that is used.", "format": "int64", "type": "string" }, "disableEarlyStopping": { "description": "Use the entire training budget. This disables the early stopping feature. When false the early stopping feature is enabled, which means that AutoML Image Classification might stop training before the entire training budget has been used.", "type": "boolean" }, "tunableParameter": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter", "description": "Trainer type for Vision TrainRequest." }, "uptrainBaseModelId": { "type": "string", "description": "The ID of `base` model for upTraining. If it is specified, the new model will be upTrained based on the `base` model for upTraining. Otherwise, the new model will be trained from scratch. The `base` model for upTraining must be in the same Project and Location as the new Model to train, and have the same modelType." }, "modelType": { "enumDescriptions": [ "Should not be set.", "A Model best tailored to be used within Google Cloud, and which cannot be exported. Default.", "A model type best tailored to be used within Google Cloud, which cannot be exported externally. Compared to the CLOUD model above, it is expected to have higher prediction accuracy.", "A model that, in addition to being available within Google Cloud, can also be exported (see ModelService.ExportModel) as TensorFlow or Core ML model and used on a mobile or edge device afterwards. Expected to have low latency, but may have lower prediction quality than other mobile models.", "A model that, in addition to being available within Google Cloud, can also be exported (see ModelService.ExportModel) as TensorFlow or Core ML model and used on a mobile or edge device with afterwards.", "A model that, in addition to being available within Google Cloud, can also be exported (see ModelService.ExportModel) as TensorFlow or Core ML model and used on a mobile or edge device afterwards. Expected to have a higher latency, but should also have a higher prediction quality than other mobile models.", "EfficientNet model for Model Garden training with customizable hyperparameters. Best tailored to be used within Google Cloud, and cannot be exported externally.", "MaxViT model for Model Garden training with customizable hyperparameters. Best tailored to be used within Google Cloud, and cannot be exported externally.", "ViT model for Model Garden training with customizable hyperparameters. Best tailored to be used within Google Cloud, and cannot be exported externally.", "CoCa model for Model Garden training with customizable hyperparameters. Best tailored to be used within Google Cloud, and cannot be exported externally." ], "enum": [ "MODEL_TYPE_UNSPECIFIED", "CLOUD", "CLOUD_1", "MOBILE_TF_LOW_LATENCY_1", "MOBILE_TF_VERSATILE_1", "MOBILE_TF_HIGH_ACCURACY_1", "EFFICIENTNET", "MAXVIT", "VIT", "COCA" ], "type": "string" }, "baseModelId": { "type": "string", "description": "The ID of the `base` model. If it is specified, the new model will be trained based on the `base` model. Otherwise, the new model will be trained from scratch. The `base` model must be in the same Project and Location as the new Model to train, and have the same modelType." } } }, "GoogleCloudAiplatformV1beta1RagRetrievalConfig": { "description": "Specifies the context retrieval config.", "properties": { "ranking": { "$ref": "GoogleCloudAiplatformV1beta1RagRetrievalConfigRanking", "description": "Optional. Config for ranking and reranking." }, "filter": { "description": "Optional. Config for filters.", "$ref": "GoogleCloudAiplatformV1beta1RagRetrievalConfigFilter" }, "topK": { "type": "integer", "format": "int32", "description": "Optional. The number of contexts to retrieve." }, "hybridSearch": { "$ref": "GoogleCloudAiplatformV1beta1RagRetrievalConfigHybridSearch", "description": "Optional. Config for Hybrid Search." } }, "id": "GoogleCloudAiplatformV1beta1RagRetrievalConfig", "type": "object" }, "GoogleCloudAiplatformV1beta1FulfillmentInput": { "description": "Input for fulfillment metric.", "type": "object", "properties": { "instance": { "description": "Required. Fulfillment instance.", "$ref": "GoogleCloudAiplatformV1beta1FulfillmentInstance" }, "metricSpec": { "description": "Required. Spec for fulfillment score metric.", "$ref": "GoogleCloudAiplatformV1beta1FulfillmentSpec" } }, "id": "GoogleCloudAiplatformV1beta1FulfillmentInput" }, "GoogleCloudAiplatformV1beta1NotebookIdleShutdownConfig": { "properties": { "idleTimeout": { "description": "Required. Duration is accurate to the second. In Notebook, Idle Timeout is accurate to minute so the range of idle_timeout (second) is: 10 * 60 ~ 1440 * 60.", "type": "string", "format": "google-duration" }, "idleShutdownDisabled": { "type": "boolean", "description": "Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate." } }, "type": "object", "description": "The idle shutdown configuration of NotebookRuntimeTemplate, which contains the idle_timeout as required field.", "id": "GoogleCloudAiplatformV1beta1NotebookIdleShutdownConfig" }, "GoogleCloudAiplatformV1beta1RubricGenerationSpec": { "properties": { "modelConfig": { "description": "Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.", "$ref": "GoogleCloudAiplatformV1beta1AutoraterConfig" }, "rubricTypeOntology": { "description": "Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.", "type": "array", "items": { "type": "string" } }, "rubricContentType": { "enumDescriptions": [ "The content type to generate is not specified.", "Generate rubrics based on properties.", "Generate rubrics in an NL question answer format.", "Generate rubrics in a unit test format." ], "type": "string", "enum": [ "RUBRIC_CONTENT_TYPE_UNSPECIFIED", "PROPERTY", "NL_QUESTION_ANSWER", "PYTHON_CODE_ASSERTION" ], "description": "The type of rubric content to be generated." }, "promptTemplate": { "type": "string", "description": "Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1RubricGenerationSpec", "description": "Specification for how rubrics should be generated." }, "GoogleCloudAiplatformV1beta1TaskOutput": { "id": "GoogleCloudAiplatformV1beta1TaskOutput", "properties": { "artifacts": { "description": "Optional. A list of artifacts (files, data) produced by the task.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1TaskArtifact" } } }, "description": "Represents the final output of a task.", "type": "object" }, "GoogleCloudAiplatformV1beta1TuningDataStats": { "id": "GoogleCloudAiplatformV1beta1TuningDataStats", "type": "object", "description": "The tuning data statistic values for TuningJob.", "properties": { "reinforcementTuningDataStats": { "$ref": "GoogleCloudAiplatformV1beta1DatasetStats", "readOnly": true, "description": "Output only. Statistics for reinforcement tuning." }, "preferenceOptimizationDataStats": { "readOnly": true, "description": "Output only. Statistics for preference optimization.", "$ref": "GoogleCloudAiplatformV1beta1PreferenceOptimizationDataStats" }, "supervisedTuningDataStats": { "description": "The SFT Tuning data stats.", "$ref": "GoogleCloudAiplatformV1beta1SupervisedTuningDataStats" }, "distillationDataStats": { "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1DistillationDataStats", "description": "Output only. Statistics for distillation prompt dataset. These statistics do not include the responses sampled from the teacher model." } } }, "GoogleCloudAiplatformV1beta1ExplainResponseConcurrentExplanation": { "id": "GoogleCloudAiplatformV1beta1ExplainResponseConcurrentExplanation", "type": "object", "description": "This message is a wrapper grouping Concurrent Explanations.", "properties": { "explanations": { "description": "The explanations of the Model's PredictResponse.predictions. It has the same number of elements as instances to be explained.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Explanation" } } } }, "GoogleCloudAiplatformV1beta1FindNeighborsResponseNearestNeighbors": { "id": "GoogleCloudAiplatformV1beta1FindNeighborsResponseNearestNeighbors", "properties": { "id": { "description": "The ID of the query datapoint.", "type": "string" }, "neighbors": { "description": "All its neighbors.", "items": { "$ref": "GoogleCloudAiplatformV1beta1FindNeighborsResponseNeighbor" }, "type": "array" } }, "type": "object", "description": "Nearest neighbors for one query." }, "GenaiVertexV1beta1ThoughtContent": { "deprecated": true, "id": "GenaiVertexV1beta1ThoughtContent", "properties": { "signature": { "description": "Signature to match the backend source to be part of the generation.", "format": "byte", "type": "string" }, "summary": { "type": "array", "description": "A summary of the thought.", "items": { "$ref": "GenaiVertexV1beta1ThoughtSummaryContent" } } }, "type": "object", "description": "A thought content block." }, "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigAgentRunConfigUserSimulatorConfig": { "id": "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigAgentRunConfigUserSimulatorConfig", "description": "Used for multi-turn agent scraping. Contains configuration for a user simulator that uses an LLM to generate messages on behalf of the user.", "properties": { "maxTurn": { "description": "Maximum number of invocations allowed by the multi-turn agent scraping. This property allows us to stop a run-off conversation, where the agent and the user simulator get into a never ending loop. The initial fixed prompt is also counted as an invocation.", "format": "int32", "type": "integer" }, "modelName": { "type": "string", "description": "The model name to use for multi-turn agent scraping to get next user message, e.g. \"gemini-3-flash-preview\"." }, "modelConfig": { "$ref": "GoogleCloudAiplatformV1beta1GenerationConfig", "description": "The configuration for the model." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ListFeatureViewsResponse": { "id": "GoogleCloudAiplatformV1beta1ListFeatureViewsResponse", "description": "Response message for FeatureOnlineStoreAdminService.ListFeatureViews.", "type": "object", "properties": { "featureViews": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1FeatureView" }, "description": "The FeatureViews matching the request." }, "nextPageToken": { "description": "A token, which can be sent as ListFeatureViewsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GenaiVertexV1beta1GoogleSearchCallContentGoogleSearchCallArguments": { "type": "object", "properties": { "queries": { "items": { "type": "string" }, "description": "Web search queries for the following-up web search.", "type": "array" } }, "description": "The arguments to pass to Google Search.", "id": "GenaiVertexV1beta1GoogleSearchCallContentGoogleSearchCallArguments" }, "GoogleCloudAiplatformV1beta1RagFileParsingConfigLayoutParser": { "type": "object", "properties": { "maxParsingRequestsPerMin": { "description": "The maximum number of requests the job is allowed to make to the Document AI processor per minute. Consult https://cloud.google.com/document-ai/quotas and the Quota page for your project to set an appropriate value here. If unspecified, a default value of 120 QPM would be used.", "format": "int32", "type": "integer" }, "processorName": { "type": "string", "description": "The full resource name of a Document AI processor or processor version. The processor must have type `LAYOUT_PARSER_PROCESSOR`. If specified, the `additional_config.parse_as_scanned_pdf` field must be false. Format: * `projects/{project_id}/locations/{location}/processors/{processor_id}` * `projects/{project_id}/locations/{location}/processors/{processor_id}/processorVersions/{processor_version_id}`" }, "globalMaxParsingRequestsPerMin": { "type": "integer", "format": "int32", "description": "The maximum number of requests the job is allowed to make to the Document AI processor per minute in this project. Consult https://cloud.google.com/document-ai/quotas and the Quota page for your project to set an appropriate value here. If this value is not specified, max_parsing_requests_per_min will be used by indexing pipeline as the global limit." } }, "id": "GoogleCloudAiplatformV1beta1RagFileParsingConfigLayoutParser", "description": "Document AI Layout Parser config." }, "GoogleCloudAiplatformV1beta1FeatureSelectionConfig": { "type": "object", "properties": { "featureConfigs": { "description": "Optional. A list of features to be monitored and each feature's drift threshold.", "items": { "$ref": "GoogleCloudAiplatformV1beta1FeatureSelectionConfigFeatureConfig" }, "type": "array" } }, "id": "GoogleCloudAiplatformV1beta1FeatureSelectionConfig", "description": "Feature selection configuration for the FeatureMonitor." }, "GoogleCloudAiplatformV1beta1ModelEvaluationSliceSliceSliceSpecRange": { "properties": { "low": { "type": "number", "description": "Inclusive low value for the range.", "format": "float" }, "high": { "description": "Exclusive high value for the range.", "type": "number", "format": "float" } }, "description": "A range of values for slice(s). `low` is inclusive, `high` is exclusive.", "id": "GoogleCloudAiplatformV1beta1ModelEvaluationSliceSliceSliceSpecRange", "type": "object" }, "GoogleCloudAiplatformV1beta1ToolConfig": { "description": "Tool config. This config is shared for all tools provided in the request.", "properties": { "functionCallingConfig": { "description": "Optional. Function calling config.", "$ref": "GoogleCloudAiplatformV1beta1FunctionCallingConfig" }, "retrievalConfig": { "description": "Optional. Retrieval config.", "$ref": "GoogleCloudAiplatformV1beta1RetrievalConfig" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ToolConfig" }, "GoogleCloudAiplatformV1beta1SupervisedTuningDatasetDistributionDatasetBucket": { "properties": { "left": { "format": "double", "type": "number", "description": "Output only. Left bound of the bucket.", "readOnly": true }, "count": { "format": "double", "description": "Output only. Number of values in the bucket.", "type": "number", "readOnly": true }, "right": { "format": "double", "description": "Output only. Right bound of the bucket.", "readOnly": true, "type": "number" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SupervisedTuningDatasetDistributionDatasetBucket", "description": "Dataset bucket used to create a histogram for the distribution given a population of values." }, "GoogleCloudAiplatformV1beta1SchemaPredictParamsVideoObjectTrackingPredictionParams": { "description": "Prediction model parameters for Video Object Tracking.", "id": "GoogleCloudAiplatformV1beta1SchemaPredictParamsVideoObjectTrackingPredictionParams", "properties": { "minBoundingBoxSize": { "description": "Only bounding boxes with shortest edge at least that long as a relative value of video frame size are returned. Default value is 0.0.", "format": "float", "type": "number" }, "maxPredictions": { "type": "integer", "format": "int32", "description": "The model only returns up to that many top, by confidence score, predictions per frame of the video. If this number is very high, the Model may return fewer predictions per frame. Default value is 50." }, "confidenceThreshold": { "type": "number", "description": "The Model only returns predictions with at least this confidence score. Default value is 0.0", "format": "float" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1TrajectoryInOrderMatchMetricValue": { "type": "object", "properties": { "score": { "type": "number", "readOnly": true, "format": "float", "description": "Output only. TrajectoryInOrderMatch score." } }, "description": "TrajectoryInOrderMatch metric value for an instance.", "id": "GoogleCloudAiplatformV1beta1TrajectoryInOrderMatchMetricValue" }, "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri": { "type": "object", "properties": { "sourceId": { "type": "string", "description": "The ID of the place or review." }, "flagContentUri": { "type": "string", "description": "The URI that can be used to flag the content." } }, "id": "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri", "description": "A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps." }, "GoogleCloudAiplatformV1beta1MigratableResourceAutomlModel": { "properties": { "modelDisplayName": { "description": "The Model's display name in automl.googleapis.com.", "type": "string" }, "model": { "description": "Full resource name of automl Model. Format: `projects/{project}/locations/{location}/models/{model}`.", "type": "string" } }, "type": "object", "description": "Represents one Model in automl.googleapis.com.", "id": "GoogleCloudAiplatformV1beta1MigratableResourceAutomlModel" }, "GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeContainerImage": { "type": "object", "properties": { "tag": { "description": "Optional. The tag of the container image. If unset, defaults to `latest`.", "type": "string" }, "repository": { "description": "Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeContainerImage", "description": "The definition of a user-provided container image to run the notebook execution in. Mirrors `google.cloud.notebooks.v2.ContainerImage`." }, "GenaiVertexV1beta1AudioResponseFormat": { "id": "GenaiVertexV1beta1AudioResponseFormat", "properties": { "bitRate": { "type": "integer", "format": "int32", "description": "Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus)." }, "sampleRate": { "description": "Sample rate in Hz.", "type": "integer", "format": "int32" }, "mimeType": { "description": "The MIME type of the audio output.", "enumDescriptions": [ "Default value. This value is unused.", "MP3 audio format.", "OGG Opus audio format.", "Raw PCM (L16) audio format.", "WAV audio format.", "A-law audio format.", "Mu-law audio format." ], "type": "string", "enum": [ "TYPE_UNSPECIFIED", "TYPE_MP3", "TYPE_OGG_OPUS", "TYPE_L16", "TYPE_WAV", "TYPE_ALAW", "TYPE_MULAW" ] }, "delivery": { "enumDescriptions": [ "Default value. This value is unused.", "Audio data is returned inline in the response.", "Audio data is returned as a URI." ], "description": "The delivery mode for the audio output.", "type": "string", "enum": [ "DELIVERY_UNSPECIFIED", "INLINE", "URI" ] } }, "type": "object", "description": "Configuration for audio output format." }, "GoogleCloudAiplatformV1beta1PscInterfaceConfig": { "id": "GoogleCloudAiplatformV1beta1PscInterfaceConfig", "type": "object", "properties": { "dnsPeeringConfigs": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1DnsPeeringConfig" }, "description": "Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project." }, "networkAttachment": { "type": "string", "description": "Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I." } }, "description": "Configuration for PSC-I." }, "GoogleCloudAiplatformV1beta1ModelMonitoringInputTimeOffset": { "id": "GoogleCloudAiplatformV1beta1ModelMonitoringInputTimeOffset", "description": "Time offset setting.", "type": "object", "properties": { "offset": { "description": "[offset] is the time difference from the cut-off time. For scheduled jobs, the cut-off time is the scheduled time. For non-scheduled jobs, it's the time when the job was created. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days.", "type": "string" }, "window": { "type": "string", "description": "[window] refers to the scope of data selected for analysis. It allows you to specify the quantity of data you wish to examine. Currently we support the following format: 'w|W': Week, 'd|D': Day, 'h|H': Hour E.g. '1h' stands for 1 hour, '2d' stands for 2 days." } } }, "GoogleCloudAiplatformV1beta1A2ATaskRecord": { "id": "GoogleCloudAiplatformV1beta1A2ATaskRecord", "description": "An A2ATaskRecord represents an A2ATask (unit of work) persisted in storage.", "type": "object", "properties": { "appId": { "description": "Optional. Agent application which created the task.", "type": "string" }, "generation": { "format": "int64", "description": "Output only. The task generation number.", "type": "string", "readOnly": true }, "updateTime": { "format": "google-datetime", "description": "Output only. The last update timestamp of the task.", "readOnly": true, "type": "string" }, "contextId": { "type": "string", "description": "Optional. A generic identifier for grouping related tasks (e.g., session_id, workflow_id)." }, "name": { "description": "Identifier. The resource name of the task. Format: `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTaskRecords/{a2a_task_record}`", "type": "string" }, "artifacts": { "readOnly": true, "description": "Output only. The artifacts produced by the task.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordArtifact" } }, "serviceMetadata": { "description": "Optional. Metadata relevant to the A2ATaskRecordService, not the agent to agent communication.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "ttl": { "type": "string", "description": "Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 24 hours by default. Valid range: (0 seconds, 1000 days]", "format": "google-duration" }, "deleteTime": { "format": "google-datetime", "description": "Output only. The deletion timestamp of the task.", "readOnly": true, "type": "string" }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "Optional. A flexible key-value map for protocol extensions to attach custom attributes to core data structures." }, "expireTime": { "format": "google-datetime", "type": "string", "description": "Output only. Timestamp of when this task is considered expired. This is *always* provided on output, and is calculated based on the `update_time` and the `ttl`.", "readOnly": true }, "history": { "items": { "$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordMessage" }, "type": "array", "description": "Output only. The history of the task messages.", "readOnly": true }, "status": { "description": "Output only. The status of the task, including the state, status message, and timestamp.", "$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordStatus", "readOnly": true }, "userId": { "description": "Optional. Task owner user ID.", "type": "string" }, "purgeTime": { "readOnly": true, "type": "string", "description": "Output only. The purge timestamp of the task.", "format": "google-datetime" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The creation timestamp of the task.", "readOnly": true } } }, "GenaiVertexV1beta1ComputerUse": { "type": "object", "properties": { "excludedPredefinedFunctions": { "description": "The list of predefined functions that are excluded from the model call.", "type": "array", "items": { "type": "string" } }, "disabledSafetyPolicies": { "type": "array", "description": "Optional. Disabled safety policies for computer use.", "items": { "enum": [ "SAFETY_POLICY_UNSPECIFIED", "FINANCIAL_TRANSACTIONS", "SENSITIVE_DATA_MODIFICATION", "COMMUNICATION_TOOL", "ACCOUNT_CREATION", "DATA_MODIFICATION", "USER_CONSENT_MANAGEMENT", "LEGAL_TERMS_AND_AGREEMENTS" ], "enumDescriptions": [ "Unspecified safety policy.", "Safety policy for financial transactions.", "Safety policy for sensitive data modification.", "Safety policy for communication tools (e.g. Gmail, Chat, Meet).", "Safety policy for account creation.", "Safety policy for data modification.", "Safety policy for user consent management.", "Safety policy for legal terms and agreements." ], "type": "string" } }, "enablePromptInjectionDetection": { "description": "Whether enable the prompt injection detection check on computer-use request.", "type": "boolean" }, "environment": { "enum": [ "ENVIRONMENT_UNSPECIFIED", "BROWSER", "MOBILE", "DESKTOP" ], "type": "string", "enumDescriptions": [ "Defaults to browser.", "Operates in a web browser.", "Operates in a mobile environment.", "Operates in a desktop environment." ], "description": "The environment being operated." } }, "description": "A tool that can be used by the model to interact with the computer.", "id": "GenaiVertexV1beta1ComputerUse" }, "GoogleCloudAiplatformV1beta1SearchNearestEntitiesRequest": { "type": "object", "properties": { "query": { "$ref": "GoogleCloudAiplatformV1beta1NearestNeighborQuery", "description": "Required. The query." }, "returnFullEntity": { "type": "boolean", "description": "Optional. If set to true, the full entities (including all vector values and metadata) of the nearest neighbors are returned; otherwise only entity id of the nearest neighbors will be returned. Note that returning full entities will significantly increase the latency and cost of the query." } }, "id": "GoogleCloudAiplatformV1beta1SearchNearestEntitiesRequest", "description": "The request message for FeatureOnlineStoreService.SearchNearestEntities." }, "GoogleCloudAiplatformV1beta1GroundednessInput": { "id": "GoogleCloudAiplatformV1beta1GroundednessInput", "description": "Input for groundedness metric.", "properties": { "instance": { "$ref": "GoogleCloudAiplatformV1beta1GroundednessInstance", "description": "Required. Groundedness instance." }, "metricSpec": { "description": "Required. Spec for groundedness metric.", "$ref": "GoogleCloudAiplatformV1beta1GroundednessSpec" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1PublisherModelConfig": { "description": "This message contains configs of a publisher model.", "id": "GoogleCloudAiplatformV1beta1PublisherModelConfig", "properties": { "loggingConfig": { "$ref": "GoogleCloudAiplatformV1beta1PredictRequestResponseLoggingConfig", "description": "Optional. The prediction request/response logging config." }, "dataSharingEnabledProvider": { "type": "string", "enumDescriptions": [ "Unspecified model provider.", "Anthropic." ], "description": "Optional. The model provider (publisher) for which the customer has enabled data sharing. For publisher models that are configured to require data sharing, a prediction request is only allowed when the model's publisher matches this provider. Otherwise, the request is rejected.", "enum": [ "MODEL_PROVIDER_UNSPECIFIED", "ANTHROPIC" ] }, "claudeFeatureConfig": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelConfigClaudeFeatureConfig", "description": "Optional. Config for Claude-specific features." }, "inferenceEventLoggingConfig": { "$ref": "GoogleCloudAiplatformV1beta1InferenceEventLoggingConfig", "description": "Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). When enabled, logs are emitted for all publisher-model traffic on the model -- Provisioned Throughput and on-demand alike. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1JiraSourceJiraQueries": { "type": "object", "properties": { "serverUri": { "type": "string", "description": "Required. The Jira server URI." }, "apiKeyConfig": { "$ref": "GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig", "description": "Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Jira API key. See [Manage API tokens for your Atlassian account](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/)." }, "customQueries": { "items": { "type": "string" }, "type": "array", "description": "A list of custom Jira queries to import. For information about JQL (Jira Query Language), see https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/" }, "email": { "type": "string", "description": "Required. The Jira email address." }, "projects": { "description": "A list of Jira projects to import in their entirety.", "items": { "type": "string" }, "type": "array" } }, "id": "GoogleCloudAiplatformV1beta1JiraSourceJiraQueries", "description": "JiraQueries contains the Jira queries and corresponding authentication." }, "GoogleCloudAiplatformV1beta1FetchFeatureValuesRequest": { "type": "object", "description": "Request message for FeatureOnlineStoreService.FetchFeatureValues. All the features under the requested feature view will be returned.", "id": "GoogleCloudAiplatformV1beta1FetchFeatureValuesRequest", "properties": { "format": { "enum": [ "FORMAT_UNSPECIFIED", "KEY_VALUE", "PROTO_STRUCT" ], "deprecated": true, "description": "Specify response data format. If not set, KeyValue format will be used. Deprecated. Use FetchFeatureValuesRequest.data_format.", "enumDescriptions": [ "Not set. Will be treated as the KeyValue format.", "Return response data in key-value format.", "Return response data in proto Struct format." ], "type": "string" }, "dataKey": { "description": "Optional. The request key to fetch feature values for.", "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDataKey" }, "dataFormat": { "enum": [ "FEATURE_VIEW_DATA_FORMAT_UNSPECIFIED", "KEY_VALUE", "PROTO_STRUCT" ], "type": "string", "enumDescriptions": [ "Not set. Will be treated as the KeyValue format.", "Return response data in key-value format.", "Return response data in proto Struct format." ], "description": "Optional. Response data format. If not set, FeatureViewDataFormat.KEY_VALUE will be used." }, "id": { "deprecated": true, "type": "string", "description": "Simple ID. The whole string will be used as is to identify Entity to fetch feature values for." } } }, "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityTraceScopePredicate": { "description": "Defines a single filter predicate.", "id": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityTraceScopePredicate", "properties": { "totalTokenUsage": { "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityNumericPredicate", "description": "Filter on the total token usage within a trace." }, "duration": { "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityNumericPredicate", "description": "Filter on the duration of a trace (in seconds)." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadata": { "description": "The metadata of Datasets that contain tables data.", "properties": { "inputConfig": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadataInputConfig" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadata" }, "GoogleCloudAiplatformV1beta1SchemaPredictPredictionVideoObjectTrackingPredictionResult": { "properties": { "frames": { "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaPredictPredictionVideoObjectTrackingPredictionResultFrame" }, "description": "All of the frames of the video in which a single object instance has been detected. The bounding boxes in the frames identify the same object.", "type": "array" }, "timeSegmentEnd": { "type": "string", "description": "The end, inclusive, of the video's time segment in which the object instance has been detected. Expressed as a number of seconds as measured from the start of the video, with fractions up to a microsecond precision, and with \"s\" appended at the end.", "format": "google-duration" }, "confidence": { "description": "The Model's confidence in correction of this prediction, higher value means higher confidence.", "type": "number", "format": "float" }, "displayName": { "type": "string", "description": "The display name of the AnnotationSpec that had been identified." }, "timeSegmentStart": { "description": "The beginning, inclusive, of the video's time segment in which the object instance has been detected. Expressed as a number of seconds as measured from the start of the video, with fractions up to a microsecond precision, and with \"s\" appended at the end.", "format": "google-duration", "type": "string" }, "id": { "description": "The resource ID of the AnnotationSpec that had been identified.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1SchemaPredictPredictionVideoObjectTrackingPredictionResult", "type": "object", "description": "Prediction output format for Video Object Tracking." }, "GoogleCloudAiplatformV1beta1StudySpecConvexStopConfig": { "id": "GoogleCloudAiplatformV1beta1StudySpecConvexStopConfig", "properties": { "autoregressiveOrder": { "format": "int64", "description": "The number of Trial measurements used in autoregressive model for value prediction. A trial won't be considered early stopping if has fewer measurement points.", "type": "string" }, "learningRateParameterName": { "type": "string", "description": "The hyper-parameter name used in the tuning job that stands for learning rate. Leave it blank if learning rate is not in a parameter in tuning. The learning_rate is used to estimate the objective value of the ongoing trial." }, "maxNumSteps": { "description": "Steps used in predicting the final objective for early stopped trials. In general, it's set to be the same as the defined steps in training / tuning. When use_steps is false, this field is set to the maximum elapsed seconds.", "type": "string", "format": "int64" }, "useSeconds": { "type": "boolean", "description": "This bool determines whether or not the rule is applied based on elapsed_secs or steps. If use_seconds==false, the early stopping decision is made according to the predicted objective values according to the target steps. If use_seconds==true, elapsed_secs is used instead of steps. Also, in this case, the parameters max_num_steps and min_num_steps are overloaded to contain max_elapsed_seconds and min_elapsed_seconds." }, "minNumSteps": { "description": "Minimum number of steps for a trial to complete. Trials which do not have a measurement with num_steps \u003e min_num_steps won't be considered for early stopping. It's ok to set it to 0, and a trial can be early stopped at any stage. By default, min_num_steps is set to be one-tenth of the max_num_steps. When use_steps is false, this field is set to the minimum elapsed seconds.", "format": "int64", "type": "string" } }, "description": "Configuration for ConvexStopPolicy.", "deprecated": true, "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaPredictParamsImageSegmentationPredictionParams": { "id": "GoogleCloudAiplatformV1beta1SchemaPredictParamsImageSegmentationPredictionParams", "description": "Prediction model parameters for Image Segmentation.", "properties": { "confidenceThreshold": { "format": "float", "description": "When the model predicts category of pixels of the image, it will only provide predictions for pixels that it is at least this much confident about. All other pixels will be classified as background. Default value is 0.5.", "type": "number" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ProbeGrpcAction": { "description": "GrpcAction checks the health of a container using a gRPC service.", "properties": { "service": { "type": "string", "description": "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." }, "port": { "description": "Port number of the gRPC service. Number must be in the range 1 to 65535.", "format": "int32", "type": "integer" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ProbeGrpcAction" }, "GoogleCloudAiplatformV1beta1AuthConfigApiKeyConfig": { "description": "Config for authentication with API key.", "id": "GoogleCloudAiplatformV1beta1AuthConfigApiKeyConfig", "properties": { "httpElementLocation": { "type": "string", "enum": [ "HTTP_IN_UNSPECIFIED", "HTTP_IN_QUERY", "HTTP_IN_HEADER", "HTTP_IN_PATH", "HTTP_IN_BODY", "HTTP_IN_COOKIE" ], "description": "Optional. The location of the API key.", "enumDescriptions": [ "", "Element is in the HTTP request query.", "Element is in the HTTP request header.", "Element is in the HTTP request path.", "Element is in the HTTP request body.", "Element is in the HTTP request cookie." ] }, "apiKeySecret": { "description": "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.", "type": "string" }, "apiKeyString": { "type": "string", "description": "Optional. The API key to be used in the request directly." }, "name": { "type": "string", "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": "object" }, "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExampleGeneratedMemory": { "description": "A memory generated by the operation.", "properties": { "fact": { "description": "Required. Represents the fact to generate a memory from.", "type": "string" }, "topics": { "items": { "$ref": "GoogleCloudAiplatformV1beta1MemoryTopicId" }, "type": "array", "description": "Optional. Represents the list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = \"jargon\"` if the extracted memory is an example of memory extraction for the custom topic `jargon`." } }, "id": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExampleGeneratedMemory", "type": "object" }, "GoogleCloudAiplatformV1beta1PreferenceOptimizationDataStats": { "type": "object", "id": "GoogleCloudAiplatformV1beta1PreferenceOptimizationDataStats", "description": "Statistics computed for datasets used for preference optimization.", "properties": { "scoresDistribution": { "description": "Output only. Dataset distributions for scores.", "$ref": "GoogleCloudAiplatformV1beta1DatasetDistribution", "readOnly": true }, "tuningDatasetExampleCount": { "type": "string", "readOnly": true, "format": "int64", "description": "Output only. Number of examples in the tuning dataset." }, "userOutputTokenDistribution": { "description": "Output only. Dataset distributions for the user output tokens.", "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1DatasetDistribution" }, "userDatasetExamples": { "items": { "$ref": "GoogleCloudAiplatformV1beta1GeminiPreferenceExample" }, "type": "array", "description": "Output only. Sample user examples in the training dataset.", "readOnly": true }, "droppedExampleIndices": { "type": "array", "items": { "format": "int64", "type": "string" }, "description": "Output only. A partial sample of the indices (starting from 1) of the dropped examples.", "readOnly": true }, "totalBillableTokenCount": { "description": "Output only. Number of billable tokens in the tuning dataset.", "format": "int64", "readOnly": true, "type": "string" }, "userInputTokenDistribution": { "$ref": "GoogleCloudAiplatformV1beta1DatasetDistribution", "description": "Output only. Dataset distributions for the user input tokens.", "readOnly": true }, "tuningStepCount": { "description": "Output only. Number of tuning steps for this Tuning Job.", "format": "int64", "type": "string", "readOnly": true }, "scoreVariancePerExampleDistribution": { "$ref": "GoogleCloudAiplatformV1beta1DatasetDistribution", "description": "Output only. Dataset distributions for scores variance per example.", "readOnly": true }, "droppedExampleReasons": { "readOnly": true, "description": "Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudAiplatformV1beta1SchemaPredictInstanceVideoClassificationPredictionInstance": { "id": "GoogleCloudAiplatformV1beta1SchemaPredictInstanceVideoClassificationPredictionInstance", "description": "Prediction input format for Video Classification.", "type": "object", "properties": { "timeSegmentStart": { "description": "The beginning, inclusive, of the video's time segment on which to perform the prediction. Expressed as a number of seconds as measured from the start of the video, with \"s\" appended at the end. Fractions are allowed, up to a microsecond precision.", "type": "string" }, "timeSegmentEnd": { "description": "The end, exclusive, of the video's time segment on which to perform the prediction. Expressed as a number of seconds as measured from the start of the video, with \"s\" appended at the end. Fractions are allowed, up to a microsecond precision, and \"inf\" or \"Infinity\" is allowed, which means the end of the video.", "type": "string" }, "content": { "description": "The Google Cloud Storage location of the video on which to perform the prediction.", "type": "string" }, "mimeType": { "type": "string", "description": "The MIME type of the content of the video. Only the following are supported: video/mp4 video/avi video/quicktime" } } }, "GoogleCloudAiplatformV1beta1PairwiseSummarizationQualityInput": { "properties": { "metricSpec": { "description": "Required. Spec for pairwise summarization quality score metric.", "$ref": "GoogleCloudAiplatformV1beta1PairwiseSummarizationQualitySpec" }, "instance": { "$ref": "GoogleCloudAiplatformV1beta1PairwiseSummarizationQualityInstance", "description": "Required. Pairwise summarization quality instance." } }, "description": "Input for pairwise summarization quality metric.", "type": "object", "id": "GoogleCloudAiplatformV1beta1PairwiseSummarizationQualityInput" }, "GoogleCloudAiplatformV1beta1SyntheticField": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SyntheticField", "properties": { "fieldName": { "description": "Optional. The name of the specific field, such as \"product_name\" or \"review_text\".", "type": "string" }, "content": { "description": "Required. The actual content or value for this field. This can be text, images, or other types of data.", "$ref": "GoogleCloudAiplatformV1beta1Content" } }, "description": "Represents a single named field within a synthetic example, consisting of a name and the actual content." }, "GoogleCloudAiplatformV1beta1ToolGoogleSearchWebSearch": { "properties": {}, "id": "GoogleCloudAiplatformV1beta1ToolGoogleSearchWebSearch", "description": "Standard web search for grounding and related configurations. Only text results are returned.", "type": "object" }, "GoogleCloudAiplatformV1beta1QuestionAnsweringHelpfulnessInput": { "description": "Input for question answering helpfulness metric.", "type": "object", "id": "GoogleCloudAiplatformV1beta1QuestionAnsweringHelpfulnessInput", "properties": { "metricSpec": { "$ref": "GoogleCloudAiplatformV1beta1QuestionAnsweringHelpfulnessSpec", "description": "Required. Spec for question answering helpfulness score metric." }, "instance": { "description": "Required. Question answering helpfulness instance.", "$ref": "GoogleCloudAiplatformV1beta1QuestionAnsweringHelpfulnessInstance" } } }, "GoogleCloudAiplatformV1beta1MigratableResourceAutomlDataset": { "id": "GoogleCloudAiplatformV1beta1MigratableResourceAutomlDataset", "description": "Represents one Dataset in automl.googleapis.com.", "properties": { "dataset": { "description": "Full resource name of automl Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`.", "type": "string" }, "datasetDisplayName": { "description": "The Dataset's display name in automl.googleapis.com.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation": { "properties": { "columnName": { "type": "string" } }, "description": "Training pipeline will infer the proper transformation based on the statistic of dataset.", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation", "type": "object" }, "GoogleCloudAiplatformV1beta1Assessment": { "properties": { "detectorFindings": { "type": "array", "description": "The list of detector findings.", "items": { "$ref": "GoogleCloudAiplatformV1beta1AssessmentDetectorFinding" } } }, "description": "Contains the detailed assessment for an analyzed session.", "id": "GoogleCloudAiplatformV1beta1Assessment", "type": "object" }, "GoogleCloudAiplatformV1beta1ListAgentsResponse": { "id": "GoogleCloudAiplatformV1beta1ListAgentsResponse", "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results. Pass this value as ListAgentsRequest.page_token in a subsequent call." }, "agents": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Agent" }, "description": "The agents matching the request." } }, "description": "Response message for AgentService.ListAgents." }, "GoogleCloudAiplatformV1beta1CreateTensorboardTimeSeriesRequest": { "properties": { "tensorboardTimeSeries": { "$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries", "description": "Required. The TensorboardTimeSeries to create." }, "parent": { "type": "string", "description": "Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`" }, "tensorboardTimeSeriesId": { "type": "string", "description": "Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match \"a-z0-9{0, 127}\"" } }, "type": "object", "description": "Request message for TensorboardService.CreateTensorboardTimeSeries.", "id": "GoogleCloudAiplatformV1beta1CreateTensorboardTimeSeriesRequest" }, "GoogleCloudAiplatformV1beta1TrajectoryExactMatchResults": { "description": "Results for TrajectoryExactMatch metric.", "properties": { "trajectoryExactMatchMetricValues": { "items": { "$ref": "GoogleCloudAiplatformV1beta1TrajectoryExactMatchMetricValue" }, "description": "Output only. TrajectoryExactMatch metric values.", "readOnly": true, "type": "array" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1TrajectoryExactMatchResults" }, "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringBigQueryTable": { "description": "ModelDeploymentMonitoringBigQueryTable specifies the BigQuery table name as well as some information of the logs stored in this table.", "type": "object", "properties": { "bigqueryTablePath": { "type": "string", "description": "The created BigQuery table to store logs. Customer could do their own query & analysis. Format: `bq://.model_deployment_monitoring_._`" }, "requestResponseLoggingSchemaVersion": { "type": "string", "readOnly": true, "description": "Output only. The schema version of the request/response logging BigQuery table. Default to v1 if unset." }, "logSource": { "enum": [ "LOG_SOURCE_UNSPECIFIED", "TRAINING", "SERVING" ], "type": "string", "enumDescriptions": [ "Unspecified source.", "Logs coming from Training dataset.", "Logs coming from Serving traffic." ], "description": "The source of log." }, "logType": { "enum": [ "LOG_TYPE_UNSPECIFIED", "PREDICT", "EXPLAIN" ], "enumDescriptions": [ "Unspecified type.", "Predict logs.", "Explain logs." ], "type": "string", "description": "The type of log." } }, "id": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringBigQueryTable" }, "GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfigTreeAHConfig": { "properties": { "leafNodeEmbeddingCount": { "description": "Optional. Number of embeddings on each leaf node. The default value is 1000 if not set.", "format": "int64", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfigTreeAHConfig", "type": "object" }, "CloudAiLargeModelsVisionGenerateVideoExperimentsAudioControlConfig": { "properties": { "useTargetAudioFromVideo": { "description": "Optional. When true, uses the audio track from the input video as the target audio instead of regenerating it. Mutually exclusive with `target_audio` below. Requires the input to be a video file, not an image sequence.", "type": "boolean" }, "targetAudio": { "description": "Optional. Audio file to use as the target audio input to Omni. Only used when `use_target_audio_from_video` is false. Cannot be set simultaneously with `use_target_audio_from_video = true`.", "$ref": "CloudAiLargeModelsVisionGenerateVideoRequestAudio" } }, "id": "CloudAiLargeModelsVisionGenerateVideoExperimentsAudioControlConfig", "type": "object", "description": "Configuration for audio control." }, "GoogleCloudAiplatformV1beta1FeaturestoreMonitoringConfigSnapshotAnalysis": { "properties": { "disabled": { "description": "The monitoring schedule for snapshot analysis. For EntityType-level config: unset / disabled = true indicates disabled by default for Features under it; otherwise by default enable snapshot analysis monitoring with monitoring_interval for Features under it. Feature-level config: disabled = true indicates disabled regardless of the EntityType-level config; unset monitoring_interval indicates going with EntityType-level config; otherwise run snapshot analysis monitoring with monitoring_interval regardless of the EntityType-level config. Explicitly Disable the snapshot analysis based monitoring.", "type": "boolean" }, "monitoringInterval": { "format": "google-duration", "deprecated": true, "description": "Configuration of the snapshot analysis based monitoring pipeline running interval. The value is rolled up to full day. If both monitoring_interval_days and the deprecated `monitoring_interval` field are set when creating/updating EntityTypes/Features, monitoring_interval_days will be used.", "type": "string" }, "stalenessDays": { "description": "Customized export features time window for snapshot analysis. Unit is one day. Default value is 3 weeks. Minimum value is 1 day. Maximum value is 4000 days.", "format": "int32", "type": "integer" }, "monitoringIntervalDays": { "description": "Configuration of the snapshot analysis based monitoring pipeline running interval. The value indicates number of days.", "type": "integer", "format": "int32" } }, "description": "Configuration of the Featurestore's Snapshot Analysis Based Monitoring. This type of analysis generates statistics for each Feature based on a snapshot of the latest feature value of each entities every monitoring_interval.", "type": "object", "id": "GoogleCloudAiplatformV1beta1FeaturestoreMonitoringConfigSnapshotAnalysis" }, "GoogleCloudAiplatformV1beta1ModalityTokenCount": { "description": "Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.", "type": "object", "properties": { "tokenCount": { "format": "int32", "type": "integer", "description": "The number of tokens counted for this modality." }, "modality": { "enum": [ "MODALITY_UNSPECIFIED", "TEXT", "IMAGE", "VIDEO", "AUDIO", "DOCUMENT" ], "enumDescriptions": [ "When a modality is not specified, it is treated as `TEXT`.", "The `Part` contains plain text.", "The `Part` contains an image.", "The `Part` contains a video.", "The `Part` contains audio.", "The `Part` contains a document, such as a PDF." ], "type": "string", "description": "The modality that this token count applies to." } }, "id": "GoogleCloudAiplatformV1beta1ModalityTokenCount" }, "GoogleCloudAiplatformV1beta1IndexPrivateEndpoints": { "properties": { "pscAutomatedEndpoints": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1PscAutomatedEndpoints" }, "description": "Output only. PscAutomatedEndpoints is populated if private service connect is enabled if PscAutomatedConfig is set.", "readOnly": true }, "serviceAttachment": { "description": "Output only. The name of the service attachment resource. Populated if private service connect is enabled.", "type": "string", "readOnly": true }, "matchGrpcAddress": { "description": "Output only. The ip address used to send match gRPC requests.", "type": "string", "readOnly": true } }, "type": "object", "description": "IndexPrivateEndpoints proto is used to provide paths for users to send requests via private endpoints (e.g. private service access, private service connect). To send request via private service access, use match_grpc_address. To send request via private service connect, use service_attachment.", "id": "GoogleCloudAiplatformV1beta1IndexPrivateEndpoints" }, "GoogleCloudAiplatformV1beta1TrajectoryRecallResults": { "type": "object", "description": "Results for TrajectoryRecall metric.", "id": "GoogleCloudAiplatformV1beta1TrajectoryRecallResults", "properties": { "trajectoryRecallMetricValues": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1TrajectoryRecallMetricValue" }, "readOnly": true, "description": "Output only. TrajectoryRecall metric values." } } }, "GoogleCloudAiplatformV1beta1StructuredMemoryConfigSchemaConfig": { "description": "Schema configuration for structured memories.", "id": "GoogleCloudAiplatformV1beta1StructuredMemoryConfigSchemaConfig", "properties": { "jsonSchema": { "description": "Optional. Represents the JSON Schema of the structured memories.", "type": "any" }, "schema": { "description": "Required. Represents the OpenAPI schema of the structured memories. The schema `type` cannot be `ARRAY` when `memory_type` is `STRUCTURED_PROFILE`.", "$ref": "GoogleCloudAiplatformV1beta1Schema" }, "id": { "description": "Required. Represents the ID of the schema. Must be 1-63 characters, start with a lowercase letter, and consist of lowercase letters, numbers, and hyphens.", "type": "string" }, "memoryType": { "type": "string", "enumDescriptions": [ "Represents an unspecified memory type. This value should not be used.", "Indicates belonging to a collection of natural language memories.", "Indicates belonging to a structured profile." ], "enum": [ "MEMORY_TYPE_UNSPECIFIED", "NATURAL_LANGUAGE_COLLECTION", "STRUCTURED_PROFILE" ], "description": "Optional. Represents the type of the structured memories associated with the schema. If not set, then `STRUCTURED_PROFILE` will be used." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ModelMonitoringJobExecutionDetailProcessedDataset": { "properties": { "timeRange": { "description": "Dataset time range information if any.", "$ref": "GoogleTypeInterval" }, "location": { "type": "string", "description": "Actual data location of the processed dataset." } }, "description": "Processed dataset information.", "id": "GoogleCloudAiplatformV1beta1ModelMonitoringJobExecutionDetailProcessedDataset", "type": "object" }, "GoogleCloudAiplatformV1beta1ReasoningEngineContextSpec": { "type": "object", "properties": { "memoryBankConfig": { "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfig", "description": "Optional. Specification for a Memory Bank, which manages memories for the Agent Engine." } }, "id": "GoogleCloudAiplatformV1beta1ReasoningEngineContextSpec", "description": "Configuration for how Agent Engine sub-resources should manage context." }, "GoogleCloudAiplatformV1beta1FunctionResponse": { "description": "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.", "properties": { "id": { "type": "string", "description": "Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`." }, "name": { "type": "string", "description": "Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name." }, "response": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "Required. The function response in JSON object format. Use \"output\" key to specify function output and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as function output." }, "parts": { "items": { "$ref": "GoogleCloudAiplatformV1beta1FunctionResponsePart" }, "description": "Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.", "type": "array" }, "scheduling": { "enum": [ "SCHEDULING_UNSPECIFIED", "SILENT", "WHEN_IDLE", "INTERRUPT" ], "description": "Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE.", "type": "string", "enumDescriptions": [ "This value is unused.", "Only add the result to the conversation context, do not interrupt or trigger generation.", "Add the result to the conversation context, and prompt to generate output without interrupting ongoing generation.", "Add the result to the conversation context, interrupt ongoing generation and prompt to generate output." ] } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1FunctionResponse" }, "GoogleCloudAiplatformV1beta1RagRetrievalConfigFilter": { "properties": { "vectorDistanceThreshold": { "description": "Optional. Only returns contexts with vector distance smaller than the threshold.", "format": "double", "type": "number" }, "vectorSimilarityThreshold": { "description": "Optional. Only returns contexts with vector similarity larger than the threshold.", "format": "double", "type": "number" }, "metadataFilter": { "type": "string", "description": "Optional. String for metadata filtering." } }, "id": "GoogleCloudAiplatformV1beta1RagRetrievalConfigFilter", "description": "Config for filters.", "type": "object" }, "GoogleCloudAiplatformV1beta1RagChunkPageSpan": { "properties": { "firstPage": { "format": "int32", "description": "Page where chunk starts in the document. Inclusive. 1-indexed.", "type": "integer" }, "lastPage": { "type": "integer", "format": "int32", "description": "Page where chunk ends in the document. Inclusive. 1-indexed." } }, "description": "Represents where the chunk starts and ends in the document.", "type": "object", "id": "GoogleCloudAiplatformV1beta1RagChunkPageSpan" }, "GoogleCloudAiplatformV1beta1ModelMonitoringStatsDataPoint": { "description": "Represents a single statistics data point.", "type": "object", "properties": { "thresholdValue": { "format": "double", "type": "number", "description": "Threshold value." }, "baselineStats": { "description": "Statistics from baseline dataset.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringStatsDataPointTypedValue" }, "modelMonitoringJob": { "type": "string", "description": "Model monitoring job resource name." }, "algorithm": { "description": "Algorithm used to calculated the metrics, eg: jensen_shannon_divergence, l_infinity.", "type": "string" }, "schedule": { "description": "Schedule resource name.", "type": "string" }, "createTime": { "description": "Statistics create time.", "type": "string", "format": "google-datetime" }, "hasAnomaly": { "description": "Indicate if the statistics has anomaly.", "type": "boolean" }, "currentStats": { "description": "Statistics from current dataset.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringStatsDataPointTypedValue" } }, "id": "GoogleCloudAiplatformV1beta1ModelMonitoringStatsDataPoint" }, "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceDataContents": { "id": "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceDataContents", "properties": { "contents": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" }, "description": "Optional. Repeated contents.", "type": "array" } }, "description": "List of standard Content messages from Gemini API.", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaPredictParamsImageClassificationPredictionParams": { "type": "object", "properties": { "confidenceThreshold": { "description": "The Model only returns predictions with at least this confidence score. Default value is 0.0", "type": "number", "format": "float" }, "maxPredictions": { "format": "int32", "type": "integer", "description": "The Model only returns up to that many top, by confidence score, predictions per instance. If this number is very high, the Model may return fewer predictions. Default value is 10." } }, "description": "Prediction model parameters for Image Classification.", "id": "GoogleCloudAiplatformV1beta1SchemaPredictParamsImageClassificationPredictionParams" }, "GoogleCloudAiplatformV1beta1ExportModelRequestOutputConfig": { "description": "Output configuration for the Model export.", "type": "object", "id": "GoogleCloudAiplatformV1beta1ExportModelRequestOutputConfig", "properties": { "exportFormatId": { "description": "The ID of the format in which the Model must be exported. Each Model lists the export formats it supports. If no value is provided here, then the first from the list of the Model's supported formats is used by default.", "type": "string" }, "imageDestination": { "description": "The Google Container Registry or Artifact Registry uri where the Model container image will be copied to. This field should only be set when the `exportableContent` field of the [Model.supported_export_formats] object contains `IMAGE`.", "$ref": "GoogleCloudAiplatformV1beta1ContainerRegistryDestination" }, "artifactDestination": { "$ref": "GoogleCloudAiplatformV1beta1GcsDestination", "description": "The Cloud Storage location where the Model artifact is to be written to. Under the directory given as the destination a new one with name \"`model-export--`\", where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format, will be created. Inside, the Model and any of its supporting files will be written. This field should only be set when the `exportableContent` field of the [Model.supported_export_formats] object contains `ARTIFACT`." } } }, "GoogleCloudAiplatformV1beta1PredictLongRunningMetadata": { "type": "object", "id": "GoogleCloudAiplatformV1beta1PredictLongRunningMetadata", "properties": {}, "description": "Metadata for PredictLongRunning long running operations." }, "GoogleCloudAiplatformV1beta1AcceptPublisherModelEulaRequest": { "type": "object", "id": "GoogleCloudAiplatformV1beta1AcceptPublisherModelEulaRequest", "properties": { "publisherModel": { "description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}`", "type": "string" } }, "description": "Request message for ModelGardenService.AcceptPublisherModelEula." }, "GoogleCloudAiplatformV1beta1IndexDatapointNumericRestriction": { "type": "object", "description": "This field allows restricts to be based on numeric comparisons rather than categorical tokens.", "id": "GoogleCloudAiplatformV1beta1IndexDatapointNumericRestriction", "properties": { "namespace": { "description": "The namespace of this restriction. e.g.: cost.", "type": "string" }, "valueDouble": { "type": "number", "description": "Represents 64 bit float.", "format": "double" }, "valueFloat": { "description": "Represents 32 bit float.", "type": "number", "format": "float" }, "valueInt": { "description": "Represents 64 bit integer.", "type": "string", "format": "int64" }, "op": { "type": "string", "description": "This MUST be specified for queries and must NOT be specified for datapoints.", "enumDescriptions": [ "Default value of the enum.", "Datapoints are eligible iff their value is \u003c the query's.", "Datapoints are eligible iff their value is \u003c= the query's.", "Datapoints are eligible iff their value is == the query's.", "Datapoints are eligible iff their value is \u003e= the query's.", "Datapoints are eligible iff their value is \u003e the query's.", "Datapoints are eligible iff their value is != the query's." ], "enum": [ "OPERATOR_UNSPECIFIED", "LESS", "LESS_EQUAL", "EQUAL", "GREATER_EQUAL", "GREATER", "NOT_EQUAL" ] } } }, "GoogleCloudAiplatformV1beta1NotebookExecutionJob": { "properties": { "name": { "type": "string", "description": "Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`", "readOnly": true }, "jobState": { "readOnly": true, "type": "string", "enum": [ "JOB_STATE_UNSPECIFIED", "JOB_STATE_QUEUED", "JOB_STATE_PENDING", "JOB_STATE_RUNNING", "JOB_STATE_SUCCEEDED", "JOB_STATE_FAILED", "JOB_STATE_CANCELLING", "JOB_STATE_CANCELLED", "JOB_STATE_PAUSED", "JOB_STATE_EXPIRED", "JOB_STATE_UPDATING", "JOB_STATE_PARTIALLY_SUCCEEDED" ], "enumDescriptions": [ "The job state is unspecified.", "The job has been just created or resumed and processing has not yet begun.", "The service is preparing to run the job.", "The job is in progress.", "The job completed successfully.", "The job failed.", "The job is being cancelled. From this state the job may only go to either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.", "The job has been cancelled.", "The job has been stopped, and can be resumed.", "The job has expired.", "The job is being updated. Only jobs in the `RUNNING` state can be updated. After updating, the job goes back to the `RUNNING` state.", "The job is partially succeeded, some results may be missing due to errors." ], "description": "Output only. The state of the NotebookExecutionJob." }, "kernelName": { "description": "The name of the kernel to use during notebook execution. If unset, the default kernel is used.", "type": "string" }, "dataformRepositorySource": { "$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJobDataformRepositorySource", "description": "The Dataform Repository pointing to a single file notebook repository." }, "customEnvironmentSpec": { "description": "The custom compute configuration for an execution job.", "$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpec" }, "executionTimeout": { "format": "google-duration", "type": "string", "description": "Max running time of the execution job in seconds (default 86400s / 24 hrs)." }, "gcsNotebookSource": { "description": "The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`", "$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJobGcsNotebookSource" }, "workbenchRuntime": { "description": "The Workbench runtime configuration to use for the notebook execution.", "$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntime" }, "gcsOutputUri": { "type": "string", "description": "The Cloud Storage location to upload the result to. Format: `gs://bucket-name`" }, "serviceAccount": { "type": "string", "description": "The service account to run the execution as." }, "updateTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. Timestamp when this NotebookExecutionJob was most recently updated." }, "notebookRuntimeTemplateResourceName": { "description": "The NotebookRuntimeTemplate to source compute configuration from.", "type": "string" }, "displayName": { "description": "The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.", "type": "string" }, "status": { "description": "Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.", "readOnly": true, "$ref": "GoogleRpcStatus" }, "scheduleResourceName": { "type": "string", "description": "The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`" }, "encryptionSpec": { "description": "Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec.", "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec" }, "directNotebookSource": { "description": "The contents of an input notebook file.", "$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJobDirectNotebookSource" }, "createTime": { "description": "Output only. Timestamp when this NotebookExecutionJob was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "labels": { "additionalProperties": { "type": "string" }, "type": "object", "description": "The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable." }, "executionUser": { "type": "string", "description": "The user email to run the execution as. Only supported by Colab runtimes." } }, "type": "object", "description": "NotebookExecutionJob represents an instance of a notebook execution.", "id": "GoogleCloudAiplatformV1beta1NotebookExecutionJob" }, "GenaiVertexV1beta1ToolResultDelta": { "type": "object", "properties": { "googleMapsResult": { "$ref": "GenaiVertexV1beta1GoogleMapsResultDelta" }, "signature": { "type": "string", "description": "A signature hash for backend validation.", "format": "byte" }, "functionResult": { "$ref": "GenaiVertexV1beta1FunctionResultDelta" }, "fileSearchResult": { "$ref": "GenaiVertexV1beta1FileSearchResultDelta" }, "callId": { "description": "Required. ID to match the ID from the function call block.", "type": "string" }, "googleSearchResult": { "$ref": "GenaiVertexV1beta1GoogleSearchResultDelta" }, "codeExecutionResult": { "$ref": "GenaiVertexV1beta1CodeExecutionResultDelta" }, "mcpServerToolResult": { "$ref": "GenaiVertexV1beta1McpServerToolResultDelta" }, "urlContextResult": { "$ref": "GenaiVertexV1beta1UrlContextResultDelta" } }, "id": "GenaiVertexV1beta1ToolResultDelta" }, "CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig": { "type": "object", "description": "Configuration for Omni Rewriter.", "properties": { "maxChunkDuration": { "type": "number", "format": "float", "description": "Optional. Maximum duration of a chunk in seconds." }, "rewriterInputFps": { "format": "int32", "description": "Optional. FPS used to generate gemini chunks for video inputs.", "type": "integer" } }, "id": "CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig" }, "GoogleCloudAiplatformV1beta1MigrateResourceRequest": { "id": "GoogleCloudAiplatformV1beta1MigrateResourceRequest", "type": "object", "description": "Config of migrating one resource from automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com to Vertex AI.", "properties": { "migrateDataLabelingDatasetConfig": { "deprecated": true, "$ref": "GoogleCloudAiplatformV1beta1MigrateResourceRequestMigrateDataLabelingDatasetConfig", "description": "Deprecated: Data labeling service is shut down. Config for migrating Dataset in datalabeling.googleapis.com to Vertex AI's Dataset." }, "migrateMlEngineModelVersionConfig": { "$ref": "GoogleCloudAiplatformV1beta1MigrateResourceRequestMigrateMlEngineModelVersionConfig", "description": "Config for migrating Version in ml.googleapis.com to Vertex AI's Model." }, "migrateAutomlDatasetConfig": { "$ref": "GoogleCloudAiplatformV1beta1MigrateResourceRequestMigrateAutomlDatasetConfig", "description": "Config for migrating Dataset in automl.googleapis.com to Vertex AI's Dataset." }, "migrateAutomlModelConfig": { "description": "Config for migrating Model in automl.googleapis.com to Vertex AI's Model.", "$ref": "GoogleCloudAiplatformV1beta1MigrateResourceRequestMigrateAutomlModelConfig" } } }, "GoogleCloudAiplatformV1beta1GroundingChunkImage": { "type": "object", "id": "GoogleCloudAiplatformV1beta1GroundingChunkImage", "description": "An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information.", "properties": { "title": { "description": "The title of the image search result page.", "type": "string" }, "domain": { "type": "string", "description": "The domain of the image search result page." }, "sourceUri": { "description": "The URI of the image search result page.", "type": "string" }, "imageUri": { "description": "The URI of the image.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardRequest": { "properties": { "sampleResponse": { "description": "Required. The sample response for validating the reward configuration.", "$ref": "GoogleCloudAiplatformV1beta1Content" }, "singleRewardConfig": { "$ref": "GoogleCloudAiplatformV1beta1SingleReinforcementTuningRewardConfig", "description": "Optional. Single Reward function configuration for reinforcement tuning." }, "example": { "description": "Required. The example to validate the reward configuration.", "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningExample" }, "compositeRewardConfig": { "description": "Optional. Composite reward function configuration for reinforcement tuning.", "$ref": "GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfig" } }, "type": "object", "description": "Request message for GenAiTuningService.ValidateReinforcementTuningReward.", "id": "GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardRequest" }, "GoogleCloudAiplatformV1beta1QuestionAnsweringHelpfulnessSpec": { "description": "Spec for question answering helpfulness metric.", "properties": { "useReference": { "description": "Optional. Whether to use instance.reference to compute question answering helpfulness.", "type": "boolean" }, "version": { "description": "Optional. Which version to use for evaluation.", "type": "integer", "format": "int32" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1QuestionAnsweringHelpfulnessSpec" }, "GoogleCloudAiplatformV1beta1FeedbackEntry": { "description": "FeedbackEntry is a resource that represents a user's feedback on a conversation with an agent.", "properties": { "customMetadata": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Optional. Additional key-value metadata associated with the feedback." }, "feedbackType": { "type": "string", "description": "Required. The coarse-grained type of feedback provided by the user. Must be set to a value other than `FEEDBACK_TYPE_UNSPECIFIED`.", "enumDescriptions": [ "This is the default value meaning the type has not been set.", "Indicates positive feedback.", "Indicates negative feedback." ], "enum": [ "FEEDBACK_TYPE_UNSPECIFIED", "THUMBS_UP", "THUMBS_DOWN" ] }, "userId": { "type": "string", "description": "Optional. A caller-supplied identifier for the user who provided the feedback. The semantics of this field (for example whether it is an opaque token, a hashed value, or a user-visible identifier) are determined by the calling application." }, "updateTime": { "description": "Output only. The time at which the entry was most recently updated.", "format": "google-datetime", "readOnly": true, "type": "string" }, "eventId": { "type": "string", "description": "Required. The ID of the event within the session that the feedback relates to." }, "feedbackText": { "type": "string", "description": "Optional. Qualitative free-form comments provided by the user." }, "source": { "description": "Optional. The surface that the feedback originated from.", "type": "string" }, "name": { "type": "string", "description": "Identifier. The resource name. Assigned by the server on create. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}`" }, "createTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The time at which the entry was created." }, "feedbackLabels": { "type": "array", "items": { "type": "string" } }, "sessionId": { "description": "Required. The ID of the session that the feedback relates to.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1FeedbackEntry", "type": "object" }, "GoogleCloudAiplatformV1beta1PredictLongRunningRequest": { "id": "GoogleCloudAiplatformV1beta1PredictLongRunningRequest", "description": "Request message for PredictionService.PredictLongRunning.", "properties": { "labels": { "type": "object", "description": "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.", "additionalProperties": { "type": "string" } }, "parameters": { "type": "any", "description": "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." }, "instances": { "items": { "type": "any" }, "description": "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.", "type": "array" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1SkillRevision": { "id": "GoogleCloudAiplatformV1beta1SkillRevision", "properties": { "name": { "type": "string", "description": "Identifier. The resource name of the Skill Revision. Format: `projects/{project}/locations/{location}/skills/{skill}/revisions/{revision}`" }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. Timestamp when this Skill Revision was created.", "format": "google-datetime" }, "skill": { "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1Skill", "description": "Output only. The state of the Skill at this revision." }, "state": { "type": "string", "description": "Output only. The state of the Skill Revision.", "enumDescriptions": [ "The state of the Skill Revision is unspecified.", "The Skill Revision is active.", "The Skill Revision is being created.", "The Skill Revision was created, but failed to process.", "The Skill Revision is being deleted." ], "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "CREATING", "FAILED", "DELETING" ], "readOnly": true } }, "description": "A revision of a Skill.", "type": "object" }, "GoogleCloudAiplatformV1beta1PurgeExecutionsResponse": { "description": "Response message for MetadataService.PurgeExecutions.", "properties": { "purgeCount": { "format": "int64", "type": "string", "description": "The number of Executions that this request deleted (or, if `force` is false, the number of Executions that will be deleted). This can be an estimate." }, "purgeSample": { "description": "A sample of the Execution names that will be deleted. Only populated if `force` is set to false. The maximum number of samples is 100 (it is possible to return fewer).", "items": { "type": "string" }, "type": "array" } }, "id": "GoogleCloudAiplatformV1beta1PurgeExecutionsResponse", "type": "object" }, "GoogleCloudAiplatformV1beta1RuntimeConfig": { "properties": { "defaultParams": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional. Default parameters that will be set for all the execution of this extension. If specified, the parameter values can be overridden by values in [[ExecuteExtensionRequest.operation_params]] at request time. The struct should be in a form of map with param name as the key and actual param value as the value. E.g. If this operation requires a param \"name\" to be set to \"abc\". you can set this to something like {\"name\": \"abc\"}." }, "codeInterpreterRuntimeConfig": { "$ref": "GoogleCloudAiplatformV1beta1RuntimeConfigCodeInterpreterRuntimeConfig", "description": "Code execution runtime configurations for code interpreter extension." }, "vertexAiSearchRuntimeConfig": { "$ref": "GoogleCloudAiplatformV1beta1RuntimeConfigVertexAISearchRuntimeConfig", "description": "Runtime configuration for Vertex AI Search extension." } }, "description": "Runtime configuration to run the extension.", "type": "object", "id": "GoogleCloudAiplatformV1beta1RuntimeConfig" }, "GoogleCloudAiplatformV1beta1CustomJob": { "id": "GoogleCloudAiplatformV1beta1CustomJob", "properties": { "labels": { "additionalProperties": { "type": "string" }, "type": "object", "description": "The labels with user-defined metadata to organize CustomJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels." }, "name": { "readOnly": true, "description": "Output only. Resource name of a CustomJob.", "type": "string" }, "displayName": { "description": "Required. The display name of the CustomJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.", "type": "string" }, "encryptionSpec": { "description": "Customer-managed encryption key options for a CustomJob. If this is set, then all resources created by the CustomJob will be encrypted with the provided encryption key.", "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec" }, "state": { "description": "Output only. The detailed state of the job.", "enumDescriptions": [ "The job state is unspecified.", "The job has been just created or resumed and processing has not yet begun.", "The service is preparing to run the job.", "The job is in progress.", "The job completed successfully.", "The job failed.", "The job is being cancelled. From this state the job may only go to either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.", "The job has been cancelled.", "The job has been stopped, and can be resumed.", "The job has expired.", "The job is being updated. Only jobs in the `RUNNING` state can be updated. After updating, the job goes back to the `RUNNING` state.", "The job is partially succeeded, some results may be missing due to errors." ], "enum": [ "JOB_STATE_UNSPECIFIED", "JOB_STATE_QUEUED", "JOB_STATE_PENDING", "JOB_STATE_RUNNING", "JOB_STATE_SUCCEEDED", "JOB_STATE_FAILED", "JOB_STATE_CANCELLING", "JOB_STATE_CANCELLED", "JOB_STATE_PAUSED", "JOB_STATE_EXPIRED", "JOB_STATE_UPDATING", "JOB_STATE_PARTIALLY_SUCCEEDED" ], "type": "string", "readOnly": true }, "updateTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. Time when the CustomJob was most recently updated." }, "jobSpec": { "$ref": "GoogleCloudAiplatformV1beta1CustomJobSpec", "description": "Required. Job spec." }, "createTime": { "description": "Output only. Time when the CustomJob was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "startTime": { "format": "google-datetime", "description": "Output only. Time when the CustomJob for the first time entered the `JOB_STATE_RUNNING` state.", "type": "string", "readOnly": true }, "endTime": { "description": "Output only. Time when the CustomJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.", "type": "string", "readOnly": true, "format": "google-datetime" }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" }, "webAccessUris": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Output only. URIs for accessing [interactive shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) (one URI for each training node). Only available if job_spec.enable_web_access is `true`. The keys are names of each node in the training job; for example, `workerpool0-0` for the primary node, `workerpool1-0` for the first node in the second worker pool, and `workerpool1-1` for the second node in the second worker pool. The values are the URIs for each node's interactive shell.", "readOnly": true }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" }, "error": { "description": "Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.", "readOnly": true, "$ref": "GoogleRpcStatus" } }, "description": "Represents a job that runs custom workloads such as a Docker container or a Python package. A CustomJob can have multiple worker pools and each worker pool can have its own machine and input spec. A CustomJob will be cleaned up once the job enters terminal state (failed or succeeded).", "type": "object" }, "GenaiVertexV1beta1CodeExecutionCallStep": { "id": "GenaiVertexV1beta1CodeExecutionCallStep", "properties": { "arguments": { "$ref": "GenaiVertexV1beta1CodeExecutionCallStepCodeExecutionCallStepArguments", "description": "Required. The arguments to pass to the code execution." } }, "type": "object", "description": "Code execution call step." }, "GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigAgentToAnywhereConfig": { "description": "Configuration for traffic originating from a Reasoning Engine.", "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigAgentToAnywhereConfig", "properties": { "agentGateway": { "description": "Required. The resource name of the Agent Gateway for outbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `AGENT_TO_ANYWHERE`. Format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}`", "type": "string" } }, "type": "object" }, "GenaiVertexV1beta1CodeMenderAgentConfig": { "description": "Configuration for the CodeMender agent.", "properties": { "model": { "description": "The name of the model to use for the CodeMender agent. One CodeMender session will only use one model.", "type": "string" }, "findRequest": { "description": "Parameters for finding vulnerabilities.", "$ref": "GenaiVertexV1beta1CodeMenderAgentConfigFindRequest" }, "fixRequest": { "$ref": "GenaiVertexV1beta1CodeMenderAgentConfigFixRequest", "description": "Parameters for fixing vulnerabilities." }, "sessionId": { "type": "string", "description": "Parameter for grouping multiple interactions that belong to the same CodeMender session." }, "sessionConfig": { "description": "Optional session-specific configurations to override default agent behavior.", "$ref": "GenaiVertexV1beta1CodeMenderAgentConfigSessionConfig" } }, "id": "GenaiVertexV1beta1CodeMenderAgentConfig", "type": "object" }, "GoogleCloudAiplatformV1beta1SummarizationVerbositySpec": { "description": "Spec for summarization verbosity score metric.", "id": "GoogleCloudAiplatformV1beta1SummarizationVerbositySpec", "type": "object", "properties": { "version": { "format": "int32", "description": "Optional. Which version to use for evaluation.", "type": "integer" }, "useReference": { "description": "Optional. Whether to use instance.reference to compute summarization verbosity.", "type": "boolean" } } }, "GoogleCloudAiplatformV1beta1MetadataList": { "id": "GoogleCloudAiplatformV1beta1MetadataList", "properties": { "values": { "items": { "$ref": "GoogleCloudAiplatformV1beta1MetadataValue" }, "type": "array", "description": "The values of `LIST` data type metadata." } }, "description": "List representation in metadata.", "type": "object" }, "GoogleCloudAiplatformV1beta1Attribution": { "description": "Attribution that explains a particular prediction output.", "properties": { "outputIndex": { "readOnly": true, "description": "Output only. The index that locates the explained prediction output. If the prediction output is a scalar value, output_index is not populated. If the prediction output has multiple dimensions, the length of the output_index list is the same as the number of dimensions of the output. The i-th element in output_index is the element index of the i-th dimension of the output vector. Indices start from 0.", "type": "array", "items": { "type": "integer", "format": "int32" } }, "baselineOutputValue": { "type": "number", "format": "double", "description": "Output only. Model predicted output if the input instance is constructed from the baselines of all the features defined in ExplanationMetadata.inputs. The field name of the output is determined by the key in ExplanationMetadata.outputs. If the Model's predicted output has multiple dimensions (rank \u003e 1), this is the value in the output located by output_index. If there are multiple baselines, their output values are averaged.", "readOnly": true }, "instanceOutputValue": { "readOnly": true, "description": "Output only. Model predicted output on the corresponding explanation instance. The field name of the output is determined by the key in ExplanationMetadata.outputs. If the Model predicted output has multiple dimensions, this is the value in the output located by output_index.", "type": "number", "format": "double" }, "outputDisplayName": { "readOnly": true, "type": "string", "description": "Output only. The display name of the output identified by output_index. For example, the predicted class name by a multi-classification Model. This field is only populated iff the Model predicts display names as a separate field along with the explained output. The predicted display name must has the same shape of the explained output, and can be located using output_index." }, "approximationError": { "readOnly": true, "description": "Output only. Error of feature_attributions caused by approximation used in the explanation method. Lower value means more precise attributions. * For Sampled Shapley attribution, increasing path_count might reduce the error. * For Integrated Gradients attribution, increasing step_count might reduce the error. * For XRAI attribution, increasing step_count might reduce the error. See [this introduction](/vertex-ai/docs/explainable-ai/overview) for more information.", "type": "number", "format": "double" }, "featureAttributions": { "type": "any", "readOnly": true, "description": "Output only. Attributions of each explained feature. Features are extracted from the prediction instances according to explanation metadata for inputs. The value is a struct, whose keys are the name of the feature. The values are how much the feature in the instance contributed to the predicted result. The format of the value is determined by the feature's input format: * If the feature is a scalar value, the attribution value is a floating number. * If the feature is an array of scalar values, the attribution value is an array. * If the feature is a struct, the attribution value is a struct. The keys in the attribution value struct are the same as the keys in the feature struct. The formats of the values in the attribution struct are determined by the formats of the values in the feature struct. The ExplanationMetadata.feature_attributions_schema_uri field, pointed to by the ExplanationSpec field of the Endpoint.deployed_models object, points to the schema file that describes the features and their attribution values (if it is populated)." }, "outputName": { "readOnly": true, "type": "string", "description": "Output only. Name of the explain output. Specified as the key in ExplanationMetadata.outputs." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1Attribution" }, "GoogleCloudAiplatformV1beta1UploadRagFileConfig": { "id": "GoogleCloudAiplatformV1beta1UploadRagFileConfig", "description": "Config for uploading RagFile.", "type": "object", "properties": { "ragFileChunkingConfig": { "$ref": "GoogleCloudAiplatformV1beta1RagFileChunkingConfig", "description": "Specifies the size and overlap of chunks after uploading RagFile.", "deprecated": true }, "ragFileMetadataConfig": { "deprecated": true, "$ref": "GoogleCloudAiplatformV1beta1RagFileMetadataConfig", "description": "Optional. Specifies the metadata config for RagFiles. Including paths for metadata schema and metadata. Alteratively, inline metadata schema and metadata can be provided. Deprecated: Not in use." }, "ragFileTransformationConfig": { "description": "Specifies the transformation config for RagFiles.", "$ref": "GoogleCloudAiplatformV1beta1RagFileTransformationConfig" }, "ragFileParsingConfig": { "$ref": "GoogleCloudAiplatformV1beta1RagFileParsingConfig", "description": "Optional. Specifies the parsing config for RagFiles. RAG will use the default parser if this field is not set." } } }, "GoogleCloudAiplatformV1beta1ModelSourceInfo": { "id": "GoogleCloudAiplatformV1beta1ModelSourceInfo", "properties": { "sourceType": { "type": "string", "enumDescriptions": [ "Should not be used.", "The Model is uploaded by automl training pipeline.", "The Model is uploaded by user or custom training pipeline.", "The Model is registered and sync'ed from BigQuery ML.", "The Model is saved or tuned from Model Garden.", "The Model is saved or tuned from Genie.", "The Model is uploaded by text embedding finetuning pipeline.", "The Model is saved or tuned from Marketplace." ], "enum": [ "MODEL_SOURCE_TYPE_UNSPECIFIED", "AUTOML", "CUSTOM", "BQML", "MODEL_GARDEN", "GENIE", "CUSTOM_TEXT_EMBEDDING", "MARKETPLACE" ], "description": "Type of the model source." }, "copy": { "description": "If this Model is copy of another Model. If true then source_type pertains to the original.", "type": "boolean" } }, "description": "Detail description of the source information of the model.", "type": "object" }, "GenaiVertexV1beta1EnvironmentConfigSource": { "id": "GenaiVertexV1beta1EnvironmentConfigSource", "type": "object", "properties": { "encoding": { "description": "Optional encoding for inline content (e.g. `base64`).", "type": "string" }, "target": { "type": "string", "description": "Where the source should appear in the environment." }, "type": { "type": "string", "enumDescriptions": [ "", "A Cloud Storage bucket.", "Inline content.", "A generic repository. The protocol prefix in the source URL identifies the provider (e.g., github://, gcs://).", "A skill resource from the Skill Registry Service. Skill: projects/{project}/locations/{location}/skills/{skill} SkillRevision: projects/{project}/locations/{location}/skills/{skill}/revisions/{revision} Support mounting all skills under a project: projects/{project}/locations/{location}/skills." ], "enum": [ "TYPE_UNSPECIFIED", "GCS", "INLINE", "REPOSITORY", "SKILL_REGISTRY" ] }, "source": { "type": "string", "description": "The source of the environment. For Cloud Storage, this is the Cloud Storage path. For GitHub, this is the GitHub path." }, "content": { "type": "string", "description": "The inline content if `type` is `INLINE`." } }, "description": "A source to be mounted into the environment." }, "GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorer": { "properties": { "wrongAnswerReward": { "type": "number", "description": "Wrong answer reward is returned if the parsed response is evaluated as `false`. All wrong answers get the same reward.", "format": "float" }, "stringMatchExpression": { "description": "Uses string match expression to evaluate parsed response.", "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerStringMatchExpression" }, "correctAnswerReward": { "format": "float", "description": "Correct answer rewawrd is returned if the parsed response is evaluated as `true`. All correct answers get the same reward.", "type": "number" }, "jsonMatchExpression": { "description": "Uses json match expression to evaluate parsed response.", "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerJsonMatchExpression" } }, "description": "ReinforcementTuningStringMatchRewardScorer is used to score parsed responses for string matching use cases. For example, for math problems, users can use string match scorer to check if the correct exact answer is generated. Note: Reward returned by the string match reward function is clipped to be within `[-1, 1]` if wrongAnswerReward or correctAnswerReward are beyond the range, i.e., `reward = max(min(reward, 1.0), -1.0)`.", "type": "object", "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorer" }, "GoogleCloudAiplatformV1beta1Dataset": { "id": "GoogleCloudAiplatformV1beta1Dataset", "description": "A collection of DataItems and Annotations on them.", "type": "object", "properties": { "modelReference": { "type": "string", "description": "Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets." }, "description": { "type": "string", "description": "The description of the Dataset." }, "encryptionSpec": { "description": "Customer-managed encryption key spec for a Dataset. If set, this Dataset and all sub-resources of this Dataset will be secured by this key.", "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec" }, "updateTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. Timestamp when this Dataset was last updated." }, "name": { "type": "string", "readOnly": true, "description": "Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`" }, "displayName": { "description": "Required. The user-defined name of the Dataset. The name can be up to 128 characters long and can consist of any UTF-8 characters.", "type": "string" }, "metadataArtifact": { "description": "Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.", "type": "string", "readOnly": true }, "metadata": { "description": "Required. Additional information about the Dataset.", "type": "any" }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "type": "boolean", "readOnly": true }, "createTime": { "format": "google-datetime", "description": "Output only. Timestamp when this Dataset was created.", "type": "string", "readOnly": true }, "metadataSchemaUri": { "description": "Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.", "type": "string" }, "savedQueries": { "items": { "$ref": "GoogleCloudAiplatformV1beta1SavedQuery" }, "type": "array", "description": "All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec." }, "dataItemCount": { "description": "Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset.", "format": "int64", "readOnly": true, "type": "string" }, "satisfiesPzi": { "type": "boolean", "description": "Output only. Reserved for future use.", "readOnly": true }, "labels": { "description": "The labels with user-defined metadata to organize your Datasets. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable. Following system labels exist for each Dataset: * \"aiplatform.googleapis.com/dataset_metadata_schema\": output only, its value is the metadata_schema's title.", "type": "object", "additionalProperties": { "type": "string" } }, "etag": { "type": "string", "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens." } } }, "GoogleCloudAiplatformV1beta1CreateTensorboardRunRequest": { "id": "GoogleCloudAiplatformV1beta1CreateTensorboardRunRequest", "properties": { "parent": { "description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", "type": "string" }, "tensorboardRun": { "$ref": "GoogleCloudAiplatformV1beta1TensorboardRun", "description": "Required. The TensorboardRun to create." }, "tensorboardRunId": { "type": "string", "description": "Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`." } }, "description": "Request message for TensorboardService.CreateTensorboardRun.", "type": "object" }, "GoogleCloudAiplatformV1beta1CopyModelResponse": { "description": "Response message of ModelService.CopyModel operation.", "properties": { "modelVersionId": { "description": "Output only. The version ID of the model that is copied.", "type": "string", "readOnly": true }, "model": { "description": "The name of the copied Model resource. Format: `projects/{project}/locations/{location}/models/{model}`", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1CopyModelResponse", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs", "properties": { "multiLabel": { "type": "boolean" } } }, "GoogleCloudAiplatformV1beta1SchemaPromptSpecTranslationOption": { "description": "Optional settings for translation prompt.", "id": "GoogleCloudAiplatformV1beta1SchemaPromptSpecTranslationOption", "type": "object", "properties": { "numberOfShots": { "description": "How many shots to use.", "format": "int32", "type": "integer" } } }, "GoogleCloudAiplatformV1beta1A2aTaskMessage": { "description": "Represents a single message in a conversation, compliant with the A2A specification.", "properties": { "parts": { "items": { "$ref": "GoogleCloudAiplatformV1beta1A2aPart" }, "type": "array", "description": "Required. The content parts that make up the message." }, "messageId": { "description": "Required. The unique identifier of the message.", "type": "string" }, "referenceTaskIds": { "type": "array", "description": "Optional. The IDs of other tasks referenced by this message.", "items": { "type": "string" } }, "role": { "description": "Required. The role of the sender of the message.", "enumDescriptions": [ "The role is unspecified.", "The message is from the client to the server.", "The message is from the server to the client." ], "type": "string", "enum": [ "ROLE_UNSPECIFIED", "ROLE_USER", "ROLE_AGENT" ] }, "extensions": { "description": "Optional. A2A protocol extensions associated with the message.", "type": "array", "items": { "type": "string" } }, "metadata": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional. Additional context or parameters related to the message. Extensions can be used to strongly type metadata values for specific use cases.", "type": "object" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1A2aTaskMessage" }, "GoogleCloudAiplatformV1beta1A2aPart": { "id": "GoogleCloudAiplatformV1beta1A2aPart", "type": "object", "description": "A single part of a message or artifact. A part carries exactly one kind of content.", "properties": { "url": { "description": "Optional. A URL pointing to the content.", "type": "string" }, "mediaType": { "description": "Optional. The IANA media type of the content, e.g. \"text/plain\" or \"image/png\".", "type": "string" }, "text": { "description": "Optional. Textual content.", "type": "string" }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases." }, "data": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. Structured data content.", "type": "object" }, "raw": { "type": "string", "format": "byte", "description": "Optional. Raw binary content." }, "filename": { "type": "string", "description": "Optional. The name of the file, when the part represents a file." } } }, "GoogleCloudAiplatformV1beta1ResourceRuntime": { "description": "Persistent Cluster runtime information as output", "id": "GoogleCloudAiplatformV1beta1ResourceRuntime", "type": "object", "properties": { "accessUris": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Output only. URIs for user to connect to the Cluster. Example: { \"RAY_HEAD_NODE_INTERNAL_IP\": \"head-node-IP:10001\" \"RAY_DASHBOARD_URI\": \"ray-dashboard-address:8888\" }", "readOnly": true }, "notebookRuntimeTemplate": { "type": "string", "description": "Output only. The resource name of NotebookRuntimeTemplate for the RoV Persistent Cluster The NotebokRuntimeTemplate is created in the same VPC (if set), and with the same Ray and Python version as the Persistent Cluster. Example: \"projects/1000/locations/us-central1/notebookRuntimeTemplates/abc123\"", "deprecated": true, "readOnly": true } } }, "GenaiVertexV1beta1RetrievalCallDelta": { "description": "Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used.", "properties": { "retrievalType": { "type": "string", "enum": [ "RETRIEVAL_TYPE_UNSPECIFIED", "RETRIEVAL_TYPE_VERTEX_AI_SEARCH", "RETRIEVAL_TYPE_RAG_STORE", "RETRIEVAL_TYPE_EXA_AI_SEARCH", "RETRIEVAL_TYPE_PARALLEL_AI_SEARCH" ], "enumDescriptions": [ "", "", "", "", "" ], "description": "The type of retrieval tools." }, "arguments": { "description": "Required. The arguments to pass to the Retrieval tool.", "$ref": "GenaiVertexV1beta1RetrievalCallStepRetrievalStepArguments" } }, "id": "GenaiVertexV1beta1RetrievalCallDelta", "type": "object" }, "GoogleCloudAiplatformV1beta1IngestionDirectContentsSourceEvent": { "description": "A single event to ingest.", "properties": { "eventId": { "type": "string", "description": "Optional. A unique identifier for the event. If an event with the same event_id is ingested multiple times, it will be de-duplicated." }, "content": { "description": "Required. The content of the event.", "$ref": "GoogleCloudAiplatformV1beta1Content" }, "eventTime": { "format": "google-datetime", "description": "Optional. The time at which the event occurred. If provided, this timestamp will be used for ordering events within a stream. If not provided, the server-side ingestion time will be used.", "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1IngestionDirectContentsSourceEvent" }, "CloudAiLargeModelsVisionVideo": { "id": "CloudAiLargeModelsVisionVideo", "properties": { "encodedVideo": { "type": "string", "description": "Base 64 encoded video bytes." }, "text": { "description": "Text/Expanded text input for Help Me Write.", "type": "string" }, "video": { "format": "byte", "type": "string", "description": "Raw bytes." }, "uri": { "type": "string", "description": "Path to another storage (typically Google Cloud Storage)." }, "encoding": { "description": "Video encoding, for example \"video/mp4\".", "type": "string" } }, "description": "Video", "type": "object" }, "GenaiVertexV1beta1Struct": { "properties": { "fields": { "description": "Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.", "items": { "$ref": "GenaiVertexV1beta1Field" }, "type": "array" } }, "id": "GenaiVertexV1beta1Struct", "description": "`Struct` represents a structured data value, consisting of fields which map to dynamically typed values.", "type": "object" }, "GoogleCloudAiplatformV1beta1RougeMetricValue": { "properties": { "score": { "format": "float", "type": "number", "readOnly": true, "description": "Output only. Rouge score." } }, "id": "GoogleCloudAiplatformV1beta1RougeMetricValue", "description": "Rouge metric value for an instance.", "type": "object" }, "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentDataAgentEvent": { "description": "A single event in the execution trace.", "id": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentDataAgentEvent", "properties": { "stateDelta": { "description": "Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "content": { "$ref": "GoogleCloudAiplatformV1beta1Content", "description": "Required. The content of the event (e.g., text response, tool call, tool response)." }, "author": { "description": "Required. The ID of the agent or entity that generated this event.", "type": "string" }, "eventTime": { "description": "Optional. The timestamp when the event occurred.", "type": "string", "format": "google-datetime" }, "activeTools": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Tool" }, "type": "array", "description": "Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1EvaluateDatasetRequest": { "properties": { "outputConfig": { "$ref": "GoogleCloudAiplatformV1beta1OutputConfig", "description": "Required. Config for evaluation output." }, "dataset": { "description": "Required. The dataset used for evaluation.", "$ref": "GoogleCloudAiplatformV1beta1EvaluationDataset" }, "autoraterConfig": { "description": "Optional. Autorater config used for evaluation. Currently only publisher Gemini models are supported. Format: `projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL}.`", "$ref": "GoogleCloudAiplatformV1beta1AutoraterConfig" }, "metrics": { "type": "array", "description": "Required. The metrics used for evaluation.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Metric" } }, "location": { "type": "string", "description": "Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project}/locations/{location}`" } }, "type": "object", "description": "Request message for EvaluationService.EvaluateDataset.", "id": "GoogleCloudAiplatformV1beta1EvaluateDatasetRequest" }, "GoogleCloudAiplatformV1beta1ListSkillRevisionsResponse": { "type": "object", "description": "Response message for SkillRegistryService.ListSkillRevisions.", "id": "GoogleCloudAiplatformV1beta1ListSkillRevisionsResponse", "properties": { "skillRevisions": { "type": "array", "description": "The list of Skill Revisions in the request page.", "items": { "$ref": "GoogleCloudAiplatformV1beta1SkillRevision" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1CreateOnlineEvaluatorOperationMetadata": { "description": "Metadata for the CreateOnlineEvaluator operation.", "type": "object", "properties": { "genericMetadata": { "description": "Common part of operation metadata.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "id": "GoogleCloudAiplatformV1beta1CreateOnlineEvaluatorOperationMetadata" }, "GoogleCloudAiplatformV1beta1UndeploySolverOperationMetadata": { "type": "object", "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "The generic operation information." } }, "description": "Runtime operation information for SolverService.UndeploySolver.", "id": "GoogleCloudAiplatformV1beta1UndeploySolverOperationMetadata" }, "GoogleCloudAiplatformV1beta1DeprovisionSemanticGovernancePolicyEngineRequest": { "type": "object", "properties": { "force": { "type": "boolean", "description": "Optional. If true, the operation bypass checks on current state and force the deprovisioning operation." } }, "id": "GoogleCloudAiplatformV1beta1DeprovisionSemanticGovernancePolicyEngineRequest", "description": "Request message for SemanticGovernancePolicyEngineService.DeprovisionSemanticGovernancePolicyEngine." }, "GoogleCloudAiplatformV1beta1MetricMetadataScoreRange": { "id": "GoogleCloudAiplatformV1beta1MetricMetadataScoreRange", "description": "The range of possible scores for this metric, used for plotting.", "properties": { "max": { "description": "Required. The maximum value of the score range (inclusive).", "type": "number", "format": "double" }, "description": { "type": "string", "description": "Optional. The description of the score explaining the directionality etc." }, "min": { "description": "Required. The minimum value of the score range (inclusive).", "type": "number", "format": "double" }, "step": { "type": "number", "format": "double", "description": "Optional. The distance between discrete steps in the range. If unset, the range is assumed to be continuous." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope": { "type": "object", "id": "GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope", "properties": { "observabilityBuckets": { "description": "Required. Customer-owned Cloud Observability bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/observationBuckets/{observation_bucket}`.", "type": "array", "items": { "type": "string" } }, "name": { "type": "string", "description": "Identifier. The resource name of the AgentAnomalyDetectionScope. Format: `projects/{project}/locations/{location}/agentAnomalyDetectionScopes/{agent_anomaly_detection_scope}`" }, "logBuckets": { "description": "Required. Customer-owned Cloud Logging bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/buckets/{bucket}`.", "type": "array", "items": { "type": "string" } }, "state": { "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING" ], "enumDescriptions": [ "The default value. This value is unused.", "The scope is being created and is not yet usable.", "The scope is active and usable.", "The scope is being deleted.", "Creation or deletion failed. The scope is not usable and must be deleted before a new scope can be created in the same region.", "The scope is being updated." ], "description": "Output only. The lifecycle state of the scope.", "type": "string" }, "displayName": { "description": "Optional. User-provided display name of the AgentAnomalyDetectionScope.", "type": "string" } }, "description": "Represents an Agent Anomaly Detection Scope." }, "GoogleCloudAiplatformV1beta1FeatureOnlineStoreBigtableBigtableMetadata": { "id": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreBigtableBigtableMetadata", "properties": { "tenantProjectId": { "description": "Tenant project ID.", "type": "string" }, "tableId": { "type": "string", "description": "The Cloud Bigtable table id." }, "instanceId": { "type": "string", "description": "The Cloud Bigtable instance id." } }, "description": "Metadata of the Bigtable instance. This is used by direct read access to the Bigtable in tenant project.", "type": "object" }, "GoogleCloudAiplatformV1beta1ImportDataConfig": { "description": "Describes the location from where we import data into a Dataset, together with the labels that will be applied to the DataItems and the Annotations.", "type": "object", "properties": { "gcsSource": { "$ref": "GoogleCloudAiplatformV1beta1GcsSource", "description": "The Google Cloud Storage location for the input content." }, "annotationLabels": { "description": "Labels that will be applied to newly imported Annotations. If two Annotations are identical, one of them will be deduped. Two Annotations are considered identical if their payload, payload_schema_uri and all of their labels are the same. These labels will be overridden by Annotation labels specified inside index file referenced by import_schema_uri, e.g. jsonl file.", "additionalProperties": { "type": "string" }, "type": "object" }, "importSchemaUri": { "description": "Required. Points to a YAML file stored on Google Cloud Storage describing the import format. Validation will be done against the schema. 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).", "type": "string" }, "dataItemLabels": { "description": "Labels that will be applied to newly imported DataItems. If an identical DataItem as one being imported already exists in the Dataset, then these labels will be appended to these of the already existing one, and if labels with identical key is imported before, the old label value will be overwritten. If two DataItems are identical in the same import data operation, the labels will be combined and if key collision happens in this case, one of the values will be picked randomly. Two DataItems are considered identical if their content bytes are identical (e.g. image bytes or pdf bytes). These labels will be overridden by Annotation labels specified inside index file referenced by import_schema_uri, e.g. jsonl file.", "type": "object", "additionalProperties": { "type": "string" } } }, "id": "GoogleCloudAiplatformV1beta1ImportDataConfig" }, "GenaiVertexV1beta1ErrorEvent": { "id": "GenaiVertexV1beta1ErrorEvent", "properties": { "error": { "$ref": "GenaiVertexV1beta1Error" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1RetrieveSkillsResponseRetrievedSkill": { "type": "object", "description": "A retrieved skill.", "id": "GoogleCloudAiplatformV1beta1RetrieveSkillsResponseRetrievedSkill", "properties": { "description": { "type": "string", "description": "The skill description." }, "skillName": { "type": "string", "description": "The skill resource name. Format: projects/{project}/locations/{location}/skills/{skill}" } } }, "GoogleCloudAiplatformV1beta1CreateNotebookExecutionJobOperationMetadata": { "type": "object", "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "The operation generic information." }, "progressMessage": { "description": "A human-readable message that shows the intermediate progress details of NotebookRuntime.", "type": "string" } }, "description": "Metadata information for NotebookService.CreateNotebookExecutionJob.", "id": "GoogleCloudAiplatformV1beta1CreateNotebookExecutionJobOperationMetadata" }, "GoogleCloudAiplatformV1beta1CodeExecutionResult": { "type": "object", "id": "GoogleCloudAiplatformV1beta1CodeExecutionResult", "description": "Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used.", "properties": { "output": { "type": "string", "description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise." }, "outcome": { "enum": [ "OUTCOME_UNSPECIFIED", "OUTCOME_OK", "OUTCOME_FAILED", "OUTCOME_DEADLINE_EXCEEDED" ], "enumDescriptions": [ "Unspecified status. This value should not be used.", "Code execution completed successfully. `output` contains the stdout, if any.", "Code execution failed. `output` contains the stderr and stdout, if any.", "Code execution ran for too long, and was cancelled. There may or may not be a partial `output` present." ], "type": "string", "description": "Required. Outcome of the code execution." }, "id": { "description": "Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1FeatureMonitoringStatsAnomaly": { "description": "A list of historical SnapshotAnalysis or ImportFeaturesAnalysis stats requested by user, sorted by FeatureStatsAnomaly.start_time descending.", "properties": { "objective": { "type": "string", "enumDescriptions": [ "If it's OBJECTIVE_UNSPECIFIED, monitoring_stats will be empty.", "Stats are generated by Import Feature Analysis.", "Stats are generated by Snapshot Analysis." ], "description": "Output only. The objective for each stats.", "readOnly": true, "enum": [ "OBJECTIVE_UNSPECIFIED", "IMPORT_FEATURE_ANALYSIS", "SNAPSHOT_ANALYSIS" ] }, "featureStatsAnomaly": { "readOnly": true, "description": "Output only. The stats and anomalies generated at specific timestamp.", "$ref": "GoogleCloudAiplatformV1beta1FeatureStatsAnomaly" } }, "id": "GoogleCloudAiplatformV1beta1FeatureMonitoringStatsAnomaly", "type": "object" }, "GoogleCloudAiplatformV1beta1CreateDatasetOperationMetadata": { "id": "GoogleCloudAiplatformV1beta1CreateDatasetOperationMetadata", "type": "object", "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "The operation generic information." } }, "description": "Runtime operation information for DatasetService.CreateDataset." }, "GoogleCloudAiplatformV1beta1AudioTranscriptionConfig": { "id": "GoogleCloudAiplatformV1beta1AudioTranscriptionConfig", "type": "object", "properties": { "languageHints": { "$ref": "GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageHints", "deprecated": true, "description": "Optional. Deprecated: Use top-level `language_codes` instead. Specifies one or more languages in the audio." }, "wordTimestamp": { "description": "Optional. Configures word-level timestamp generation.", "type": "boolean" }, "languageCodes": { "description": "Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to automatic language detection.", "items": { "type": "string" }, "type": "array" }, "customVocabulary": { "description": "Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms.", "type": "array", "items": { "type": "string" } }, "diarization": { "description": "Optional. Configures speaker diarization.", "type": "boolean" }, "languageAuto": { "$ref": "GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageAuto", "description": "Optional. Deprecated: Use top-level `language_codes` instead. The model will detect the language automatically.", "deprecated": true }, "adaptationPhrases": { "type": "array", "items": { "type": "string" }, "deprecated": true, "description": "Optional. Deprecated: Use `custom_vocabulary` instead. A list of phrases to bias the speech recognition model towards." } }, "description": "Configuration for speech recognition (transcription)." }, "GoogleCloudAiplatformV1beta1NearestNeighborQuery": { "description": "A query to find a number of similar entities.", "properties": { "entityId": { "description": "Optional. The entity id whose similar entities should be searched for. If embedding is set, search will use embedding instead of entity_id.", "type": "string" }, "embedding": { "$ref": "GoogleCloudAiplatformV1beta1NearestNeighborQueryEmbedding", "description": "Optional. The embedding vector that be used for similar search." }, "parameters": { "description": "Optional. Parameters that can be set to tune query on the fly.", "$ref": "GoogleCloudAiplatformV1beta1NearestNeighborQueryParameters" }, "numericFilters": { "items": { "$ref": "GoogleCloudAiplatformV1beta1NearestNeighborQueryNumericFilter" }, "description": "Optional. The list of numeric filters.", "type": "array" }, "perCrowdingAttributeNeighborCount": { "format": "int32", "description": "Optional. Crowding is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than sper_crowding_attribute_neighbor_count of the k neighbors returned have the same value of crowding_attribute. It's used for improving result diversity.", "type": "integer" }, "stringFilters": { "items": { "$ref": "GoogleCloudAiplatformV1beta1NearestNeighborQueryStringFilter" }, "description": "Optional. The list of string filters.", "type": "array" }, "neighborCount": { "type": "integer", "format": "int32", "description": "Optional. The number of similar entities to be retrieved from feature view for each query." } }, "id": "GoogleCloudAiplatformV1beta1NearestNeighborQuery", "type": "object" }, "GoogleCloudAiplatformV1beta1UndeployIndexOperationMetadata": { "properties": { "genericMetadata": { "description": "The operation generic information.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "description": "Runtime operation information for IndexEndpointService.UndeployIndex.", "id": "GoogleCloudAiplatformV1beta1UndeployIndexOperationMetadata", "type": "object" }, "GoogleCloudAiplatformV1beta1UpdateExplanationDatasetOperationMetadata": { "description": "Runtime operation information for ModelService.UpdateExplanationDataset.", "id": "GoogleCloudAiplatformV1beta1UpdateExplanationDatasetOperationMetadata", "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "The common part of the operation metadata." } }, "type": "object" }, "GenaiVertexV1beta1CodeMenderAgentConfigFileContent": { "properties": { "path": { "type": "string", "description": "The relative path of the file from the project root." }, "content": { "description": "The UTF-8 encoded text content of the file.", "type": "string" } }, "id": "GenaiVertexV1beta1CodeMenderAgentConfigFileContent", "description": "Content of a single file in the codebase.", "type": "object" }, "GenaiVertexV1beta1Interaction": { "properties": { "usage": { "$ref": "GenaiVertexV1beta1InteractionUsage", "readOnly": true, "description": "Output only. Statistics on the interaction request's token usage." }, "responseFormat": { "$ref": "GenaiVertexV1beta1Value", "description": "Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.", "deprecated": true }, "systemInstruction": { "type": "string", "description": "System instruction for the interaction." }, "tools": { "items": { "$ref": "GenaiVertexV1beta1Tool" }, "type": "array", "description": "A list of tool declarations the model may call during interaction." }, "stepList": { "description": "Input only. The steps for the interaction.", "$ref": "GenaiVertexV1beta1StepList" }, "responseFormatSingleton": { "$ref": "GenaiVertexV1beta1ResponseFormat" }, "created": { "type": "string", "description": "Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).", "readOnly": true }, "modelInteraction": { "description": "Interaction for generating the completion using models.", "$ref": "GenaiVertexV1beta1ModelInteraction" }, "labels": { "description": "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.", "type": "object", "additionalProperties": { "type": "string" } }, "environmentId": { "type": "string", "readOnly": true, "description": "Output only. The environment ID for the interaction. Only populated if environment config is set in the request." }, "agentInteraction": { "description": "Interaction for generating the completion using agents.", "$ref": "GenaiVertexV1beta1AgentInteraction" }, "errors": { "type": "array", "items": { "$ref": "GenaiVertexV1beta1Error" }, "description": "Output only. Diagnostic faults / platform errors recorded on the interaction.", "readOnly": true }, "role": { "readOnly": true, "type": "string", "description": "Output only. The role of the interaction.", "deprecated": true }, "responseFormatList": { "$ref": "GenaiVertexV1beta1ResponseFormatList" }, "serviceTier": { "enum": [ "SERVICE_TIER_UNSPECIFIED", "SERVICE_TIER_FLEX", "SERVICE_TIER_STANDARD", "SERVICE_TIER_PRIORITY", "SERVICE_TIER_DEFERRED" ], "enumDescriptions": [ "Default service tier, which is standard.", "Flex service tier.", "Standard service tier.", "Priority service tier.", "Deferred service tier." ], "description": "The service tier for the interaction.", "type": "string" }, "outputs": { "type": "array", "description": "Output only. Responses from the model.", "items": { "$ref": "GenaiVertexV1beta1Content" }, "readOnly": true, "deprecated": true }, "envId": { "description": "The environment ID for the interaction. Can be 'remote' for default environment.", "type": "string" }, "contentList": { "description": "The inputs for the interaction.", "$ref": "GenaiVertexV1beta1ContentList", "deprecated": true }, "responseModalities": { "deprecated": true, "type": "array", "items": { "type": "string", "enum": [ "RESPONSE_MODALITY_UNSPECIFIED", "TEXT", "IMAGE", "AUDIO", "VIDEO", "DOCUMENT" ], "enumDescriptions": [ "Default value. This value is unused.", "Indicates the model should return text.", "Indicates the model should return images.", "Indicates the model should return audio.", "Indicates the model should return video.", "Indicates the model should return documents." ] }, "description": "The requested modalities of the response (TEXT, IMAGE, AUDIO)." }, "id": { "description": "Required. Output only. A unique identifier for the interaction completion.", "type": "string", "readOnly": true }, "stringContent": { "type": "string", "description": "A string input for the interaction, it will be processed as a single text input." }, "content": { "$ref": "GenaiVertexV1beta1Content", "description": "The content for the interaction." }, "status": { "enum": [ "UNSPECIFIED", "IN_PROGRESS", "REQUIRES_ACTION", "COMPLETED", "FAILED", "CANCELLED", "INCOMPLETE", "BUDGET_EXCEEDED", "QUEUED" ], "readOnly": true, "description": "Required. Output only. The status of the interaction.", "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "The interaction is in progress.", "The interaction requires action/input from the user.", "The interaction is completed.", "The interaction failed.", "The interaction was cancelled.", "The interaction is completed, but contains incomplete results (e.g. hitting max_tokens).", "The interaction was halted because the token budget was exceeded.", "The interaction is queued, waiting for processing (e.g. waiting for off-peak capacity)." ] }, "localEnvironment": { "description": "The agent's environment lives on the client connection: its built-in environment operations (filesystem ops and running commands) are yielded to the client to execute, instead of running in a server-managed sandbox. Mutually exclusive with `remote_environment`. (Independent of any client-declared function tools, which are always executed on the client regardless of this field.)", "$ref": "GenaiVertexV1beta1LocalEnvironmentConfig" }, "safetySettings": { "items": { "$ref": "GenaiVertexV1beta1SafetySetting" }, "description": "Safety settings for the interaction.", "type": "array" }, "steps": { "readOnly": true, "description": "Required. Output only. The steps that make up the interaction.", "items": { "$ref": "GenaiVertexV1beta1Step" }, "type": "array" }, "previousInteractionId": { "type": "string", "description": "The ID of the previous interaction, if any." }, "responseMimeType": { "description": "The mime type of the response. This is required if response_format is set.", "type": "string", "deprecated": true }, "remoteEnvironment": { "$ref": "GenaiVertexV1beta1EnvironmentConfig" }, "updated": { "description": "Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).", "readOnly": true, "type": "string" } }, "id": "GenaiVertexV1beta1Interaction", "type": "object", "description": "Response for InteractionService.CreateInteraction." }, "GoogleCloudAiplatformV1beta1ToolParameterKeyMatchSpec": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ToolParameterKeyMatchSpec", "description": "Spec for tool parameter key match metric.", "properties": {} }, "GoogleCloudAiplatformV1beta1ReinforcementTuningExample": { "description": "User-facing format for Gemini Reinforcement Tuning examples on Vertex.", "type": "object", "properties": { "references": { "description": "References for the given prompt. The key is the name of the reference, and the value is the reference itself. Users can use this field together with the reward configurations to calculate rewards for reinforcement tuning. For example, users can set the following references: ``` { \"concise_answer\": \"Yes\", \"verbose_answer\": \"The answer is Yes\" } ``` Then in a ReinforcementTuningCodeExecutionRewardScorer reward function config, for example, they can define a python code snippet as follows: ``` def evaluate(example, response) -\u003e float: response_str = response.get(\"parts\", [])0 references = example.get(\"references\", {}) if response_str == references.get(\"concise_answer\"): return 1.0 return -1.0 ``` In this case, references can serve the purpose of holding the ground truth of this example in the training/validation dataset.", "additionalProperties": { "type": "string" }, "type": "object" }, "tools": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Tool" }, "description": "Optional. Corresponds to tools in user-facing GenerateContentRequest." }, "contents": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" }, "type": "array", "description": "Multi-turn contents that represents the Prompt." }, "systemInstruction": { "description": "Corresponds to system_instruction in user-facing GenerateContentRequest.", "$ref": "GoogleCloudAiplatformV1beta1Content" } }, "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningExample" }, "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigSparseEmbeddingConfigBm25": { "type": "object", "id": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigSparseEmbeddingConfigBm25", "properties": { "b": { "type": "number", "format": "float", "description": "Optional. The parameter to control document length normalization. It determines how much the document length affects the final score. b is in the range of [0, 1]. The default value is 0.75." }, "multilingual": { "type": "boolean", "description": "Optional. Use multilingual tokenizer if set to true." }, "k1": { "format": "float", "type": "number", "description": "Optional. The parameter to control term frequency saturation. It determines the scaling between the matching term frequency and final score. k1 is in the range of [1.2, 3]. The default value is 1.2." } }, "description": "Message for BM25 parameters." }, "GoogleCloudAiplatformV1beta1RetrieveContextsResponse": { "type": "object", "id": "GoogleCloudAiplatformV1beta1RetrieveContextsResponse", "description": "Response message for VertexRagService.RetrieveContexts.", "properties": { "contexts": { "description": "The contexts of the query.", "$ref": "GoogleCloudAiplatformV1beta1RagContexts" } } }, "GoogleCloudAiplatformV1beta1ListExampleStoresResponse": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ListExampleStoresResponse", "properties": { "exampleStores": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1ExampleStore" }, "description": "List of ExampleStore in the requested page." }, "nextPageToken": { "description": "A token to retrieve the next page of results. Pass to ListExampleStoresRequest.page_token to obtain that page.", "type": "string" } }, "description": "Response message for ExampleStoreService.ListExampleStores." }, "GoogleCloudAiplatformV1beta1RagDataSchema": { "properties": { "schemaDetails": { "$ref": "GoogleCloudAiplatformV1beta1RagMetadataSchemaDetails", "description": "The schema details mapping to the key." }, "name": { "description": "Identifier. Resource name of the data schema in the form of: `projects/{project_number}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}` where the {rag_data_schema} part should be the same as the `key` field below.", "type": "string" }, "key": { "description": "Required. The key of this data schema. This key should be matching the key of user specified metadata and unique inside corpus. This value can be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1RagDataSchema", "description": "The schema of the user specified metadata.", "type": "object" }, "GenaiVertexV1beta1TextAnnotationDelta": { "type": "object", "properties": { "annotations": { "type": "array", "items": { "$ref": "GenaiVertexV1beta1TextContentAnnotation" }, "description": "Citation information for model-generated content." } }, "id": "GenaiVertexV1beta1TextAnnotationDelta" }, "GoogleCloudAiplatformV1beta1Execution": { "properties": { "updateTime": { "description": "Output only. Timestamp when this Execution was last updated.", "type": "string", "readOnly": true, "format": "google-datetime" }, "displayName": { "type": "string", "description": "User provided display name of the Execution. May be up to 128 Unicode characters." }, "labels": { "additionalProperties": { "type": "string" }, "description": "The labels with user-defined metadata to organize your Executions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Execution (System labels are excluded).", "type": "object" }, "state": { "enumDescriptions": [ "Unspecified Execution state", "The Execution is new", "The Execution is running", "The Execution has finished running", "The Execution has failed", "The Execution completed through Cache hit.", "The Execution was cancelled." ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "NEW", "RUNNING", "COMPLETE", "FAILED", "CACHED", "CANCELLED" ], "description": "The state of this Execution. This is a property of the Execution, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines) and the system does not prescribe or check the validity of state transitions." }, "schemaTitle": { "type": "string", "description": "The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store." }, "createTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp when this Execution was created.", "type": "string" }, "etag": { "description": "An eTag used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "type": "string" }, "description": { "type": "string", "description": "Description of the Execution" }, "metadata": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Properties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB." }, "schemaVersion": { "description": "The version of the schema in `schema_title` to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.", "type": "string" }, "name": { "type": "string", "readOnly": true, "description": "Output only. The resource name of the Execution." } }, "id": "GoogleCloudAiplatformV1beta1Execution", "type": "object", "description": "Instance of a general execution." }, "GenaiVertexV1beta1CodeExecutionCallStepCodeExecutionCallStepArguments": { "description": "The arguments to pass to the code execution.", "properties": { "code": { "type": "string", "description": "The code to be executed." }, "language": { "type": "string", "enumDescriptions": [ "Unspecified language. This value should not be used.", "Python \u003e= 3.10, with numpy and simpy available." ], "enum": [ "LANGUAGE_UNSPECIFIED", "PYTHON" ], "description": "Programming language of the `code`." } }, "type": "object", "id": "GenaiVertexV1beta1CodeExecutionCallStepCodeExecutionCallStepArguments" }, "GoogleCloudAiplatformV1beta1BatchDeleteRagMetadataRequest": { "properties": { "names": { "description": "Required. The RagMetadata to delete. A maximum of 500 rag metadata can be deleted in a batch.", "items": { "type": "string" }, "type": "array" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1BatchDeleteRagMetadataRequest", "description": "Request message for VertexRagDataService.BatchDeleteRagMetadata." }, "GoogleCloudAiplatformV1beta1BatchMigrateResourcesOperationMetadata": { "id": "GoogleCloudAiplatformV1beta1BatchMigrateResourcesOperationMetadata", "type": "object", "description": "Runtime operation information for MigrationService.BatchMigrateResources.", "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "The common part of the operation metadata." }, "partialResults": { "items": { "$ref": "GoogleCloudAiplatformV1beta1BatchMigrateResourcesOperationMetadataPartialResult" }, "description": "Partial results that reflect the latest migration operation progress.", "type": "array" } } }, "GoogleCloudAiplatformV1beta1PipelineTaskDetail": { "id": "GoogleCloudAiplatformV1beta1PipelineTaskDetail", "description": "The runtime detail of a task execution.", "type": "object", "properties": { "inputs": { "description": "Output only. The runtime input artifacts of the task.", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1PipelineTaskDetailArtifactList" }, "type": "object", "readOnly": true }, "parentTaskId": { "description": "Output only. The id of the parent task if the task is within a component scope. Empty if the task is at the root level.", "format": "int64", "readOnly": true, "type": "string" }, "executorDetail": { "$ref": "GoogleCloudAiplatformV1beta1PipelineTaskExecutorDetail", "description": "Output only. The detailed execution info.", "readOnly": true }, "createTime": { "type": "string", "readOnly": true, "description": "Output only. Task create time.", "format": "google-datetime" }, "state": { "description": "Output only. State of the task.", "enum": [ "STATE_UNSPECIFIED", "PENDING", "RUNNING", "SUCCEEDED", "CANCEL_PENDING", "CANCELLING", "CANCELLED", "FAILED", "SKIPPED", "NOT_TRIGGERED" ], "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified.", "Specifies pending state for the task.", "Specifies task is being executed.", "Specifies task completed successfully.", "Specifies Task cancel is in pending state.", "Specifies task is being cancelled.", "Specifies task was cancelled.", "Specifies task failed.", "Specifies task was skipped due to cache hit.", "Specifies that the task was not triggered because the task's trigger policy is not satisfied. The trigger policy is specified in the `condition` field of PipelineJob.pipeline_spec." ] }, "taskUniqueName": { "readOnly": true, "type": "string", "description": "Output only. The unique name of a task. This field is used by rerun pipeline job. Console UI and Vertex AI SDK will support triggering pipeline job reruns. The name is constructed by concatenating all the parent tasks name with the task name. For example, if a task named \"child_task\" has a parent task named \"parent_task_1\" and parent task 1 has a parent task named \"parent_task_2\", the task unique name will be \"parent_task_2.parent_task_1.child_task\"." }, "pipelineTaskStatus": { "items": { "$ref": "GoogleCloudAiplatformV1beta1PipelineTaskDetailPipelineTaskStatus" }, "type": "array", "readOnly": true, "description": "Output only. A list of task status. This field keeps a record of task status evolving over time." }, "error": { "$ref": "GoogleRpcStatus", "readOnly": true, "description": "Output only. The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED." }, "startTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Task start time.", "type": "string" }, "execution": { "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1Execution", "description": "Output only. The execution metadata of the task." }, "outputs": { "description": "Output only. The runtime output artifacts of the task.", "type": "object", "readOnly": true, "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1PipelineTaskDetailArtifactList" } }, "endTime": { "type": "string", "format": "google-datetime", "description": "Output only. Task end time.", "readOnly": true }, "taskName": { "type": "string", "readOnly": true, "description": "Output only. The user specified name of the task that is defined in pipeline_spec." }, "taskId": { "readOnly": true, "description": "Output only. The system generated ID of the task.", "type": "string", "format": "int64" } } }, "GoogleCloudAiplatformV1beta1GeminiPreferenceExample": { "id": "GoogleCloudAiplatformV1beta1GeminiPreferenceExample", "properties": { "contents": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" }, "description": "Multi-turn contents that represents the Prompt.", "type": "array" }, "completions": { "type": "array", "description": "List of completions for a given prompt.", "items": { "$ref": "GoogleCloudAiplatformV1beta1GeminiPreferenceExampleCompletion" } } }, "description": "Input example for preference optimization.", "type": "object" }, "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveConfig": { "properties": { "explanationConfig": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveConfigExplanationConfig", "description": "The config for integrating with Vertex Explainable AI." }, "trainingDataset": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveConfigTrainingDataset", "description": "Training dataset for models. This field has to be set only if TrainingPredictionSkewDetectionConfig is specified." }, "predictionDriftDetectionConfig": { "description": "The config for drift of prediction data.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig" }, "trainingPredictionSkewDetectionConfig": { "description": "The config for skew between training data and prediction data.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig" } }, "description": "The objective configuration for model monitoring, including the information needed to detect anomalies for one particular model.", "id": "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveConfig", "type": "object" }, "GoogleCloudAiplatformV1beta1ExactMatchMetricValue": { "description": "Exact match metric value for an instance.", "properties": { "score": { "type": "number", "format": "float", "description": "Output only. Exact match score.", "readOnly": true } }, "id": "GoogleCloudAiplatformV1beta1ExactMatchMetricValue", "type": "object" }, "GoogleCloudAiplatformV1beta1StoredContentsExampleParametersContentSearchKey": { "type": "object", "id": "GoogleCloudAiplatformV1beta1StoredContentsExampleParametersContentSearchKey", "properties": { "contents": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" }, "type": "array", "description": "Required. The conversation for generating a search key." }, "searchKeyGenerationMethod": { "description": "Required. The method of generating a search key.", "$ref": "GoogleCloudAiplatformV1beta1StoredContentsExampleSearchKeyGenerationMethod" } }, "description": "The chat history to use to generate the search key for retrieval." }, "GoogleCloudAiplatformV1beta1GroundingChunk": { "properties": { "web": { "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkWeb", "description": "A grounding chunk from a web page, typically from Google Search. See the `Web` message for details." }, "maps": { "description": "A grounding chunk from Google Maps. See the `Maps` message for details.", "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkMaps" }, "retrievedContext": { "description": "A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details", "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext" }, "image": { "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkImage", "description": "A grounding chunk from an image search result. See the `Image` message for details." } }, "id": "GoogleCloudAiplatformV1beta1GroundingChunk", "type": "object", "description": "A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information." }, "GoogleCloudAiplatformV1beta1ToolParameterKVMatchInput": { "id": "GoogleCloudAiplatformV1beta1ToolParameterKVMatchInput", "properties": { "instances": { "items": { "$ref": "GoogleCloudAiplatformV1beta1ToolParameterKVMatchInstance" }, "type": "array", "description": "Required. Repeated tool parameter key value match instances." }, "metricSpec": { "$ref": "GoogleCloudAiplatformV1beta1ToolParameterKVMatchSpec", "description": "Required. Spec for tool parameter key value match metric." } }, "description": "Input for tool parameter key value match metric.", "type": "object" }, "GenaiVertexV1beta1Retrieval": { "id": "GenaiVertexV1beta1Retrieval", "properties": { "retrievalTypes": { "type": "array", "items": { "type": "string", "enum": [ "RETRIEVAL_TYPE_UNSPECIFIED", "RETRIEVAL_TYPE_VERTEX_AI_SEARCH", "RETRIEVAL_TYPE_RAG_STORE", "RETRIEVAL_TYPE_EXA_AI_SEARCH", "RETRIEVAL_TYPE_PARALLEL_AI_SEARCH" ], "enumDescriptions": [ "", "", "", "", "" ] }, "description": "The types of file retrieval to enable." }, "ragStoreConfig": { "description": "Used to specify configuration for RagStore.", "$ref": "GenaiVertexV1beta1RagStoreConfig" }, "exaAiSearchConfig": { "description": "Used to specify configuration for ExaAISearch.", "$ref": "GenaiVertexV1beta1ExaAISearchConfig" }, "parallelAiSearchConfig": { "description": "Used to specify configuration for ParallelAISearch.", "$ref": "GenaiVertexV1beta1ParallelAISearchConfig" }, "vertexAiSearchConfig": { "description": "Used to specify configuration for VertexAISearch.", "$ref": "GenaiVertexV1beta1VertexAISearchConfig" } }, "description": "A tool that can be used by the model to retrieve files.", "type": "object" }, "GoogleCloudAiplatformV1beta1EntityIdSelector": { "type": "object", "properties": { "entityIdField": { "description": "Source column that holds entity IDs. If not provided, entity IDs are extracted from the column named entity_id.", "type": "string" }, "csvSource": { "$ref": "GoogleCloudAiplatformV1beta1CsvSource", "description": "Source of Csv" } }, "description": "Selector for entityId. Getting ids from the given source.", "id": "GoogleCloudAiplatformV1beta1EntityIdSelector" }, "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfig": { "properties": { "ranking": { "$ref": "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigRanking", "description": "Optional. Config for ranking and reranking." }, "filter": { "$ref": "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigFilter", "description": "Optional. Config for filters." }, "hybridSearch": { "description": "Optional. Config for Hybrid Search.", "$ref": "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigHybridSearch" }, "topK": { "description": "Optional. The number of contexts to retrieve.", "type": "integer", "format": "int32" } }, "description": "Specifies the context retrieval config.", "type": "object", "id": "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfig" }, "GoogleCloudAiplatformV1beta1SpeakerVoiceConfig": { "description": "Configuration for a single speaker in a multi-speaker setup.", "type": "object", "properties": { "speaker": { "description": "Required. The name of the speaker. This should be the same as the speaker name used in the prompt.", "type": "string" }, "voiceConfig": { "$ref": "GoogleCloudAiplatformV1beta1VoiceConfig", "description": "Required. The configuration for the voice of this speaker." } }, "id": "GoogleCloudAiplatformV1beta1SpeakerVoiceConfig" }, "GoogleCloudAiplatformV1beta1EmbedContentResponse": { "description": "Response message for PredictionService.EmbedContent.", "properties": { "usageMetadata": { "$ref": "GoogleCloudAiplatformV1beta1UsageMetadata", "description": "Usage metadata about the response(s)." }, "embedding": { "$ref": "GoogleCloudAiplatformV1beta1EmbedContentResponseEmbedding", "description": "The embedding generated from the input content." }, "truncated": { "description": "Whether the input content was truncated before generating the embedding.", "type": "boolean" } }, "id": "GoogleCloudAiplatformV1beta1EmbedContentResponse", "type": "object" }, "GenaiVertexV1beta1CodeMenderAgentConfigFixRequest": { "description": "Request parameters specific to FIX sessions, used for generating and validating security patches.", "properties": { "findingId": { "type": "string", "description": "The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability." }, "sourceFiles": { "type": "array", "items": { "$ref": "GenaiVertexV1beta1CodeMenderAgentConfigFileContent" }, "description": "A list of source files providing context for the remediation. These files are typically the ones containing the identified vulnerability." }, "description": { "description": "Additional context or custom instructions provided by the user to guide the patch generation process.", "type": "string" } }, "id": "GenaiVertexV1beta1CodeMenderAgentConfigFixRequest", "type": "object" }, "GenaiVertexV1beta1TextResponseFormat": { "description": "Configuration for text output format.", "type": "object", "id": "GenaiVertexV1beta1TextResponseFormat", "properties": { "mimeType": { "type": "string", "enum": [ "TYPE_UNSPECIFIED", "TYPE_APPLICATION_JSON", "TYPE_TEXT_PLAIN" ], "description": "The MIME type of the text output.", "enumDescriptions": [ "Default value. This value is unused.", "JSON output format.", "Plain text output format." ] }, "schema": { "$ref": "GenaiVertexV1beta1Struct", "description": "The JSON schema that the output should conform to. Only applicable when mime_type is application/json." } } }, "GoogleCloudAiplatformV1beta1SchemaPredictInstanceVideoActionRecognitionPredictionInstance": { "type": "object", "properties": { "timeSegmentEnd": { "description": "The end, exclusive, of the video's time segment on which to perform the prediction. Expressed as a number of seconds as measured from the start of the video, with \"s\" appended at the end. Fractions are allowed, up to a microsecond precision, and \"inf\" or \"Infinity\" is allowed, which means the end of the video.", "type": "string" }, "content": { "description": "The Google Cloud Storage location of the video on which to perform the prediction.", "type": "string" }, "mimeType": { "type": "string", "description": "The MIME type of the content of the video. Only the following are supported: video/mp4 video/avi video/quicktime" }, "timeSegmentStart": { "description": "The beginning, inclusive, of the video's time segment on which to perform the prediction. Expressed as a number of seconds as measured from the start of the video, with \"s\" appended at the end. Fractions are allowed, up to a microsecond precision.", "type": "string" } }, "description": "Prediction input format for Video Action Recognition.", "id": "GoogleCloudAiplatformV1beta1SchemaPredictInstanceVideoActionRecognitionPredictionInstance" }, "GoogleCloudAiplatformV1beta1CompactSessionRequest": { "type": "object", "id": "GoogleCloudAiplatformV1beta1CompactSessionRequest", "description": "Request message for SessionService.CompactSession.", "properties": { "compaction": { "$ref": "GoogleCloudAiplatformV1beta1CompactionConfig", "description": "Required. The compaction configuration to apply. At least one compaction category (summarization or event editing) must be enabled within it." } } }, "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentConfig": { "properties": { "subAgents": { "items": { "type": "string" }, "description": "Optional. The list of valid agent IDs (names) that this agent can delegate to. This defines the directed edges in the agent system graph topology.", "type": "array" }, "toolsText": { "description": "A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters.", "type": "string" }, "tools": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentConfigTools", "description": "List of tools." }, "agentId": { "description": "Optional. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map.", "type": "string" }, "agentType": { "description": "Optional. The type or class of the agent (e.g., \"LlmAgent\", \"RouterAgent\", \"ToolUseAgent\"). Useful for the autorater to understand the expected behavior of the agent.", "type": "string" }, "developerInstruction": { "description": "Optional. Contains instructions from the developer for the agent. Can be static or a dynamic prompt template used with the `AgentEvent.state_delta` field.", "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData" }, "description": { "description": "Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly.", "type": "string" } }, "deprecated": true, "id": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentConfig", "description": "Deprecated: Use `google.cloud.aiplatform.master.AgentConfig` in `agent_eval_data` instead. Configuration for an Agent.", "type": "object" }, "GoogleCloudAiplatformV1beta1EvaluationPromptUserScenario": { "id": "GoogleCloudAiplatformV1beta1EvaluationPromptUserScenario", "type": "object", "properties": { "startingPrompt": { "description": "Required. The prompt that starts the conversation between the simulated user and the agent under test.", "type": "string" }, "conversationPlan": { "description": "Required. The plan for the conversation, used to drive the multi-turn agent run and generate the simulated agent evaluation dataset.", "type": "string" } }, "description": "User scenario to help simulate multi-turn agent running results." }, "GoogleCloudAiplatformV1beta1ExportFeatureValuesOperationMetadata": { "description": "Details of operations that exports Features values.", "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "Operation metadata for Featurestore export Feature values." } }, "id": "GoogleCloudAiplatformV1beta1ExportFeatureValuesOperationMetadata", "type": "object" }, "GoogleCloudAiplatformV1beta1EvaluateInstancesResponse": { "id": "GoogleCloudAiplatformV1beta1EvaluateInstancesResponse", "properties": { "pointwiseMetricResult": { "description": "Generic metrics. Result for pointwise metric.", "$ref": "GoogleCloudAiplatformV1beta1PointwiseMetricResult" }, "questionAnsweringCorrectnessResult": { "description": "Result for question answering correctness metric.", "$ref": "GoogleCloudAiplatformV1beta1QuestionAnsweringCorrectnessResult" }, "bleuResults": { "description": "Results for bleu metric.", "$ref": "GoogleCloudAiplatformV1beta1BleuResults" }, "rubricBasedInstructionFollowingResult": { "description": "Result for rubric based instruction following metric.", "$ref": "GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingResult" }, "toolParameterKeyMatchResults": { "description": "Results for tool parameter key match metric.", "$ref": "GoogleCloudAiplatformV1beta1ToolParameterKeyMatchResults" }, "summarizationHelpfulnessResult": { "description": "Result for summarization helpfulness metric.", "$ref": "GoogleCloudAiplatformV1beta1SummarizationHelpfulnessResult" }, "questionAnsweringQualityResult": { "$ref": "GoogleCloudAiplatformV1beta1QuestionAnsweringQualityResult", "description": "Question answering only metrics. Result for question answering quality metric." }, "trajectoryAnyOrderMatchResults": { "description": "Result for trajectory any order match metric.", "$ref": "GoogleCloudAiplatformV1beta1TrajectoryAnyOrderMatchResults" }, "summarizationQualityResult": { "$ref": "GoogleCloudAiplatformV1beta1SummarizationQualityResult", "description": "Summarization only metrics. Result for summarization quality metric." }, "summarizationVerbosityResult": { "$ref": "GoogleCloudAiplatformV1beta1SummarizationVerbosityResult", "description": "Result for summarization verbosity metric." }, "groundednessResult": { "$ref": "GoogleCloudAiplatformV1beta1GroundednessResult", "description": "Result for groundedness metric." }, "metricxResult": { "description": "Result for Metricx metric.", "$ref": "GoogleCloudAiplatformV1beta1MetricxResult" }, "cometResult": { "description": "Translation metrics. Result for Comet metric.", "$ref": "GoogleCloudAiplatformV1beta1CometResult" }, "toolParameterKvMatchResults": { "$ref": "GoogleCloudAiplatformV1beta1ToolParameterKVMatchResults", "description": "Results for tool parameter key value match metric." }, "questionAnsweringHelpfulnessResult": { "description": "Result for question answering helpfulness metric.", "$ref": "GoogleCloudAiplatformV1beta1QuestionAnsweringHelpfulnessResult" }, "trajectorySingleToolUseResults": { "$ref": "GoogleCloudAiplatformV1beta1TrajectorySingleToolUseResults", "description": "Results for trajectory single tool use metric." }, "toolNameMatchResults": { "description": "Results for tool name match metric.", "$ref": "GoogleCloudAiplatformV1beta1ToolNameMatchResults" }, "questionAnsweringRelevanceResult": { "$ref": "GoogleCloudAiplatformV1beta1QuestionAnsweringRelevanceResult", "description": "Result for question answering relevance metric." }, "metricResults": { "description": "Metric results for each instance. The order of the metric results is guaranteed to be the same as the order of the instances in the request.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1MetricResult" } }, "trajectoryPrecisionResults": { "$ref": "GoogleCloudAiplatformV1beta1TrajectoryPrecisionResults", "description": "Result for trajectory precision metric." }, "rougeResults": { "$ref": "GoogleCloudAiplatformV1beta1RougeResults", "description": "Results for rouge metric." }, "fulfillmentResult": { "description": "Result for fulfillment metric.", "$ref": "GoogleCloudAiplatformV1beta1FulfillmentResult" }, "trajectoryRecallResults": { "$ref": "GoogleCloudAiplatformV1beta1TrajectoryRecallResults", "description": "Results for trajectory recall metric." }, "pairwiseQuestionAnsweringQualityResult": { "$ref": "GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualityResult", "description": "Result for pairwise question answering quality metric." }, "pairwiseMetricResult": { "$ref": "GoogleCloudAiplatformV1beta1PairwiseMetricResult", "description": "Result for pairwise metric." }, "exactMatchResults": { "description": "Auto metric evaluation results. Results for exact match metric.", "$ref": "GoogleCloudAiplatformV1beta1ExactMatchResults" }, "safetyResult": { "description": "Result for safety metric.", "$ref": "GoogleCloudAiplatformV1beta1SafetyResult" }, "fluencyResult": { "description": "LLM-based metric evaluation result. General text generation metrics, applicable to other categories. Result for fluency metric.", "$ref": "GoogleCloudAiplatformV1beta1FluencyResult" }, "trajectoryExactMatchResults": { "$ref": "GoogleCloudAiplatformV1beta1TrajectoryExactMatchResults", "description": "Result for trajectory exact match metric." }, "toolCallValidResults": { "description": "Tool call metrics. Results for tool call valid metric.", "$ref": "GoogleCloudAiplatformV1beta1ToolCallValidResults" }, "coherenceResult": { "description": "Result for coherence metric.", "$ref": "GoogleCloudAiplatformV1beta1CoherenceResult" }, "trajectoryInOrderMatchResults": { "description": "Result for trajectory in order match metric.", "$ref": "GoogleCloudAiplatformV1beta1TrajectoryInOrderMatchResults" }, "pairwiseSummarizationQualityResult": { "$ref": "GoogleCloudAiplatformV1beta1PairwiseSummarizationQualityResult", "description": "Result for pairwise summarization quality metric." } }, "description": "Response message for EvaluationService.EvaluateInstances.", "type": "object" }, "GoogleCloudAiplatformV1beta1StringArray": { "properties": { "values": { "type": "array", "description": "A list of string values.", "items": { "type": "string" } } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1StringArray", "description": "A list of string values." }, "GoogleCloudAiplatformV1beta1ToolParameterKVMatchInstance": { "description": "Spec for tool parameter key value match instance.", "type": "object", "properties": { "prediction": { "type": "string", "description": "Required. Output of the evaluated model." }, "reference": { "type": "string", "description": "Required. Ground truth used to compare against the prediction." } }, "id": "GoogleCloudAiplatformV1beta1ToolParameterKVMatchInstance" }, "GoogleCloudAiplatformV1beta1PipelineTaskExecutorDetailCustomJobDetail": { "properties": { "job": { "readOnly": true, "description": "Output only. The name of the CustomJob.", "type": "string" }, "failedJobs": { "readOnly": true, "items": { "type": "string" }, "description": "Output only. The names of the previously failed CustomJob. The list includes the all attempts in chronological order.", "type": "array" } }, "description": "The detailed info for a custom job executor.", "type": "object", "id": "GoogleCloudAiplatformV1beta1PipelineTaskExecutorDetailCustomJobDetail" }, "GoogleCloudAiplatformV1beta1PurgeContextsMetadata": { "properties": { "genericMetadata": { "description": "Operation metadata for purging Contexts.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "description": "Details of operations that perform MetadataService.PurgeContexts.", "type": "object", "id": "GoogleCloudAiplatformV1beta1PurgeContextsMetadata" }, "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfig": { "properties": { "generationConfig": { "$ref": "GoogleCloudAiplatformV1beta1GenerationConfig", "description": "Optional. Generation config." }, "agentRunConfig": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigAgentRunConfig", "description": "Optional. Agent run config." }, "promptTemplate": { "description": "Optional. The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values. If not specified, the prompt template in the EvaluationConfig will be used.", "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigPromptTemplate" }, "model": { "type": "string", "description": "Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`" }, "agents": { "description": "Optional. Contains the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent.", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1AgentConfig" }, "type": "object" }, "parallelism": { "format": "int32", "type": "integer", "description": "Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used." }, "agentConfig": { "description": "Optional. Deprecated: Use `agents` instead. Agent config used to generate responses.", "deprecated": true, "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigInferenceAgentConfig" } }, "id": "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfig", "type": "object", "description": "Defines the configuration for a candidate model or agent being evaluated. `InferenceConfig` encapsulates all the necessary information to invoke or scrape the candidate during the evaluation run. This includes direct model inference parameters, agent execution settings, and multi-turn scraping configurations (such as user simulators). It serves as the primary representation of the candidate across different stages of the evaluation process." }, "GoogleCloudAiplatformV1beta1DataItemView": { "properties": { "annotations": { "description": "The Annotations on the DataItem. If too many Annotations should be returned for the DataItem, this field will be truncated per annotations_limit in request. If it was, then the has_truncated_annotations will be set to true.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Annotation" } }, "hasTruncatedAnnotations": { "description": "True if and only if the Annotations field has been truncated. It happens if more Annotations for this DataItem met the request's annotation_filter than are allowed to be returned by annotations_limit. Note that if Annotations field is not being returned due to field mask, then this field will not be set to true no matter how many Annotations are there.", "type": "boolean" }, "dataItem": { "$ref": "GoogleCloudAiplatformV1beta1DataItem", "description": "The DataItem." } }, "description": "A container for a single DataItem and Annotations on it.", "type": "object", "id": "GoogleCloudAiplatformV1beta1DataItemView" }, "GoogleCloudAiplatformV1beta1FulfillmentSpec": { "description": "Spec for fulfillment metric.", "properties": { "version": { "description": "Optional. Which version to use for evaluation.", "format": "int32", "type": "integer" } }, "id": "GoogleCloudAiplatformV1beta1FulfillmentSpec", "type": "object" }, "GenaiVertexV1beta1ProcessingResultStep": { "description": "The result of a server-initiated media processing step.", "id": "GenaiVertexV1beta1ProcessingResultStep", "type": "object", "properties": {} }, "GoogleCloudAiplatformV1beta1MetricxInstance": { "type": "object", "properties": { "reference": { "description": "Optional. Ground truth used to compare against the prediction.", "type": "string" }, "source": { "description": "Optional. Source text in original language.", "type": "string" }, "prediction": { "description": "Required. Output of the evaluated model.", "type": "string" } }, "description": "Spec for MetricX instance - The fields used for evaluation are dependent on the MetricX version.", "id": "GoogleCloudAiplatformV1beta1MetricxInstance" }, "GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStore": { "description": "The data source for Vertex RagStore.", "properties": { "ragResources": { "description": "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.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStoreRagResource" } }, "ragCorpora": { "deprecated": true, "type": "array", "items": { "type": "string" }, "description": "Optional. Deprecated. Please use rag_resources to specify the data source." }, "vectorDistanceThreshold": { "description": "Optional. Only return contexts with vector distance smaller than the threshold.", "type": "number", "deprecated": true, "format": "double" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStore" }, "GoogleCloudAiplatformV1beta1Tool": { "id": "GoogleCloudAiplatformV1beta1Tool", "description": "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).", "properties": { "googleMaps": { "$ref": "GoogleCloudAiplatformV1beta1GoogleMaps", "description": "Optional. GoogleMaps tool type. Tool to support Google Maps in Model." }, "googleSearchRetrieval": { "description": "Optional. Specialized retrieval tool that is powered by Google Search.", "deprecated": true, "$ref": "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval" }, "urlContext": { "$ref": "GoogleCloudAiplatformV1beta1UrlContext", "description": "Optional. Tool to support URL context retrieval." }, "enterpriseWebSearch": { "description": "Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.", "$ref": "GoogleCloudAiplatformV1beta1EnterpriseWebSearch" }, "codeExecution": { "$ref": "GoogleCloudAiplatformV1beta1ToolCodeExecution", "description": "Optional. CodeExecution tool type. Enables the model to execute code as part of generation." }, "exaAiSearch": { "$ref": "GoogleCloudAiplatformV1beta1ToolExaAiSearch", "description": "Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation" }, "retrieval": { "description": "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.", "$ref": "GoogleCloudAiplatformV1beta1Retrieval" }, "googleSearch": { "$ref": "GoogleCloudAiplatformV1beta1ToolGoogleSearch", "description": "Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google." }, "parallelAiSearch": { "description": "Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation", "$ref": "GoogleCloudAiplatformV1beta1ToolParallelAiSearch" }, "computerUse": { "description": "Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.", "$ref": "GoogleCloudAiplatformV1beta1ToolComputerUse" }, "functionDeclarations": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1FunctionDeclaration" }, "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 512 function declarations can be provided." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ReadIndexDatapointsRequest": { "description": "The request message for MatchService.ReadIndexDatapoints.", "id": "GoogleCloudAiplatformV1beta1ReadIndexDatapointsRequest", "properties": { "ids": { "description": "IDs of the datapoints to be searched for.", "type": "array", "items": { "type": "string" } }, "deployedIndexId": { "type": "string", "description": "The ID of the DeployedIndex that will serve the request." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ModelArmorConfig": { "properties": { "responseTemplateName": { "description": "Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.", "type": "string" }, "promptTemplateName": { "description": "Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.", "type": "string" } }, "type": "object", "description": "Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks.", "id": "GoogleCloudAiplatformV1beta1ModelArmorConfig" }, "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequestSimilaritySearchParams": { "type": "object", "properties": { "searchQuery": { "type": "string", "description": "Required. Query to use for similarity search retrieval. If provided, then the parent ReasoningEngine must have ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig set." }, "topK": { "description": "Optional. The maximum number of memories to return. The service may return fewer than this value. If unspecified, at most 3 memories will be returned. The maximum value is 100; values above 100 will be coerced to 100.", "format": "int32", "type": "integer" } }, "description": "Parameters for semantic similarity search based retrieval.", "id": "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequestSimilaritySearchParams" }, "GoogleCloudAiplatformV1beta1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig": { "type": "object", "properties": { "annotatedDataset": { "description": "Required. Full resource name of data labeling AnnotatedDataset. Format: `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig", "description": "Config for migrating AnnotatedDataset in datalabeling.googleapis.com to Vertex AI's SavedQuery." }, "GoogleCloudAiplatformV1beta1ListTensorboardsResponse": { "type": "object", "description": "Response message for TensorboardService.ListTensorboards.", "properties": { "tensorboards": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Tensorboard" }, "description": "The Tensorboards mathching the request.", "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as ListTensorboardsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1ListTensorboardsResponse" }, "GenaiVertexV1beta1ContentDelta": { "id": "GenaiVertexV1beta1ContentDelta", "type": "object", "properties": { "index": { "format": "int32", "type": "integer" }, "delta": { "$ref": "GenaiVertexV1beta1ContentDeltaData" } } }, "GoogleCloudAiplatformV1beta1MigratableResourceDataLabelingDataset": { "description": "Represents one Dataset in datalabeling.googleapis.com.", "id": "GoogleCloudAiplatformV1beta1MigratableResourceDataLabelingDataset", "properties": { "dataset": { "description": "Full resource name of data labeling Dataset. Format: `projects/{project}/datasets/{dataset}`.", "type": "string" }, "dataLabelingAnnotatedDatasets": { "items": { "$ref": "GoogleCloudAiplatformV1beta1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset" }, "type": "array", "description": "The migratable AnnotatedDataset in datalabeling.googleapis.com belongs to the data labeling Dataset." }, "datasetDisplayName": { "description": "The Dataset's display name in datalabeling.googleapis.com.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1PipelineJobDetail": { "properties": { "taskDetails": { "readOnly": true, "items": { "$ref": "GoogleCloudAiplatformV1beta1PipelineTaskDetail" }, "description": "Output only. The runtime details of the tasks under the pipeline.", "type": "array" }, "pipelineRunContext": { "readOnly": true, "description": "Output only. The context of the current pipeline run.", "$ref": "GoogleCloudAiplatformV1beta1Context" }, "pipelineContext": { "$ref": "GoogleCloudAiplatformV1beta1Context", "readOnly": true, "description": "Output only. The context of the pipeline." } }, "description": "The runtime detail of PipelineJob.", "id": "GoogleCloudAiplatformV1beta1PipelineJobDetail", "type": "object" }, "GoogleCloudAiplatformV1beta1IndexStats": { "type": "object", "properties": { "shardsCount": { "format": "int32", "type": "integer", "description": "Output only. The number of shards in the Index.", "readOnly": true }, "vectorsCount": { "readOnly": true, "type": "string", "description": "Output only. The number of dense vectors in the Index.", "format": "int64" }, "sparseVectorsCount": { "format": "int64", "description": "Output only. The number of sparse vectors in the Index.", "readOnly": true, "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1IndexStats", "description": "Stats of the Index." }, "GenaiVertexV1beta1InteractionUsage": { "id": "GenaiVertexV1beta1InteractionUsage", "properties": { "groundingToolCount": { "items": { "$ref": "GenaiVertexV1beta1InteractionUsageGroundingToolCount" }, "type": "array", "description": "Grounding tool count." }, "toolUseTokensByModality": { "description": "A breakdown of tool-use token usage by modality.", "items": { "$ref": "GenaiVertexV1beta1InteractionUsageModalityTokens" }, "type": "array" }, "cachedTokensByModality": { "description": "A breakdown of cached token usage by modality.", "items": { "$ref": "GenaiVertexV1beta1InteractionUsageModalityTokens" }, "type": "array" }, "totalInputTokens": { "type": "integer", "description": "Number of tokens in the prompt (context).", "format": "int32" }, "totalThoughtTokens": { "type": "integer", "description": "Number of tokens of thoughts for thinking models.", "format": "int32" }, "totalOutputTokens": { "format": "int32", "description": "Total number of tokens across all the generated responses.", "type": "integer" }, "totalTokens": { "format": "int32", "type": "integer", "description": "Total token count for the interaction request (prompt + responses + other internal tokens)." }, "totalCachedTokens": { "format": "int32", "type": "integer", "description": "Number of tokens in the cached part of the prompt (the cached content)." }, "outputTokensByModality": { "description": "A breakdown of output token usage by modality.", "type": "array", "items": { "$ref": "GenaiVertexV1beta1InteractionUsageModalityTokens" } }, "inputTokensByModality": { "items": { "$ref": "GenaiVertexV1beta1InteractionUsageModalityTokens" }, "description": "A breakdown of input token usage by modality.", "type": "array" }, "totalToolUseTokens": { "format": "int32", "type": "integer", "description": "Number of tokens present in tool-use prompt(s)." } }, "description": "Statistics on the interaction request's token usage.", "type": "object" }, "GoogleCloudAiplatformV1beta1AddExecutionEventsResponse": { "id": "GoogleCloudAiplatformV1beta1AddExecutionEventsResponse", "description": "Response message for MetadataService.AddExecutionEvents.", "type": "object", "properties": {} }, "GoogleCloudAiplatformV1beta1FeatureViewBigQuerySource": { "properties": { "uri": { "description": "Required. The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig.", "type": "string" }, "entityIdColumns": { "items": { "type": "string" }, "description": "Required. Columns to construct entity_id / row keys.", "type": "array" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1FeatureViewBigQuerySource" }, "GoogleCloudAiplatformV1beta1DeployIndexOperationMetadata": { "description": "Runtime operation information for IndexEndpointService.DeployIndex.", "properties": { "genericMetadata": { "description": "The operation generic information.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" }, "deployedIndexId": { "description": "The unique index id specified by user", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1DeployIndexOperationMetadata", "type": "object" }, "GoogleCloudAiplatformV1beta1CreateTensorboardOperationMetadata": { "properties": { "genericMetadata": { "description": "Operation metadata for Tensorboard.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "id": "GoogleCloudAiplatformV1beta1CreateTensorboardOperationMetadata", "description": "Details of operations that perform create Tensorboard.", "type": "object" }, "GoogleCloudAiplatformV1beta1ImportExtensionOperationMetadata": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ImportExtensionOperationMetadata", "description": "Details of ExtensionRegistryService.ImportExtension operation.", "properties": { "genericMetadata": { "description": "The common part of the operation metadata.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } } }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation": { "type": "object", "properties": { "columnName": { "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation", "description": "Training pipeline will perform following transformation functions. * The value converted to float32. * The z_score of the value. * log(value+1) when the value is greater than or equal to 0. Otherwise, this transformation is not applied and the value is considered a missing value. * z_score of log(value+1) when the value is greater than or equal to 0. Otherwise, this transformation is not applied and the value is considered a missing value. * A boolean value that indicates whether the value is valid." }, "GoogleCloudAiplatformV1beta1ListModelEvaluationSlicesResponse": { "type": "object", "properties": { "modelEvaluationSlices": { "items": { "$ref": "GoogleCloudAiplatformV1beta1ModelEvaluationSlice" }, "type": "array", "description": "List of ModelEvaluations in the requested page." }, "nextPageToken": { "description": "A token to retrieve next page of results. Pass to ListModelEvaluationSlicesRequest.page_token to obtain that page.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1ListModelEvaluationSlicesResponse", "description": "Response message for ModelService.ListModelEvaluationSlices." }, "GoogleCloudAiplatformV1beta1UserActionReference": { "description": "References an API call. It contains more information about long running operation and Jobs that are triggered by the API call.", "properties": { "method": { "description": "The method name of the API RPC call. For example, \"/google.cloud.aiplatform.{apiVersion}.DatasetService.CreateDataset\"", "type": "string" }, "dataLabelingJob": { "description": "For API calls that start a LabelingJob. Resource name of the LabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`", "type": "string" }, "operation": { "description": "For API calls that return a long running operation. Resource name of the long running operation. Format: `projects/{project}/locations/{location}/operations/{operation}`", "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1UserActionReference" }, "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval": { "properties": { "dynamicRetrievalConfig": { "$ref": "GoogleCloudAiplatformV1beta1DynamicRetrievalConfig", "description": "Specifies the dynamic retrieval configuration for the given source." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval", "description": "Tool to retrieve public web data for grounding, powered by Google." }, "GoogleCloudAiplatformV1beta1ModelMonitoringJobExecutionDetail": { "properties": { "objectiveStatus": { "description": "Status of data processing for each monitoring objective. Key is the objective.", "additionalProperties": { "$ref": "GoogleRpcStatus" }, "type": "object" }, "targetDatasets": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringJobExecutionDetailProcessedDataset" }, "description": "Processed target datasets." }, "baselineDatasets": { "type": "array", "description": "Processed baseline datasets.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringJobExecutionDetailProcessedDataset" } }, "error": { "$ref": "GoogleRpcStatus", "description": "Additional job error status." } }, "id": "GoogleCloudAiplatformV1beta1ModelMonitoringJobExecutionDetail", "description": "Represent the execution details of the job.", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadataBigQuerySource": { "id": "GoogleCloudAiplatformV1beta1SchemaTablesDatasetMetadataBigQuerySource", "properties": { "uri": { "description": "The URI of a BigQuery table. e.g. bq://projectId.bqDatasetId.bqTableId", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1RemoveDatapointsResponse": { "id": "GoogleCloudAiplatformV1beta1RemoveDatapointsResponse", "properties": {}, "type": "object", "description": "Response message for IndexService.RemoveDatapoints" }, "GoogleCloudAiplatformV1beta1StudySpecTransferLearningConfig": { "description": "This contains flag for manually disabling transfer learning for a study. The names of prior studies being used for transfer learning (if any) are also listed here.", "properties": { "disableTransferLearning": { "description": "Flag to to manually prevent vizier from using transfer learning on a new study. Otherwise, vizier will automatically determine whether or not to use transfer learning.", "type": "boolean" }, "priorStudyNames": { "description": "Output only. Names of previously completed studies", "items": { "type": "string" }, "readOnly": true, "type": "array" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1StudySpecTransferLearningConfig" }, "GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate": { "type": "object", "id": "GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate", "properties": { "isDefault": { "deprecated": true, "type": "boolean", "description": "Output only. Deprecated: This field has no behavior. Use notebook_runtime_type = 'ONE_CLICK' instead. The default template to use if not specified.", "readOnly": true }, "encryptionSpec": { "description": "Customer-managed encryption key spec for the notebook runtime.", "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec" }, "networkSpec": { "description": "Optional. Network spec.", "$ref": "GoogleCloudAiplatformV1beta1NetworkSpec" }, "updateTime": { "type": "string", "readOnly": true, "description": "Output only. Timestamp when this NotebookRuntimeTemplate was most recently updated.", "format": "google-datetime" }, "etag": { "type": "string", "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens." }, "labels": { "additionalProperties": { "type": "string" }, "description": "The labels with user-defined metadata to organize the NotebookRuntimeTemplates. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.", "type": "object" }, "dataPersistentDiskSpec": { "$ref": "GoogleCloudAiplatformV1beta1PersistentDiskSpec", "description": "Optional. The specification of persistent disk attached to the runtime as data disk storage." }, "shieldedVmConfig": { "description": "Optional. Immutable. Runtime Shielded VM spec.", "$ref": "GoogleCloudAiplatformV1beta1ShieldedVmConfig" }, "softwareConfig": { "$ref": "GoogleCloudAiplatformV1beta1NotebookSoftwareConfig", "description": "Optional. The notebook software configuration of the notebook runtime." }, "idleShutdownConfig": { "$ref": "GoogleCloudAiplatformV1beta1NotebookIdleShutdownConfig", "description": "The idle shutdown configuration of NotebookRuntimeTemplate. This config will only be set when idle shutdown is enabled." }, "description": { "type": "string", "description": "The description of the NotebookRuntimeTemplate." }, "machineSpec": { "description": "Optional. Immutable. The specification of a single machine for the template.", "$ref": "GoogleCloudAiplatformV1beta1MachineSpec" }, "name": { "description": "The resource name of the NotebookRuntimeTemplate.", "type": "string" }, "networkTags": { "description": "Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).", "type": "array", "items": { "type": "string" } }, "reservationAffinity": { "description": "Optional. Reservation Affinity of the notebook runtime template.", "$ref": "GoogleCloudAiplatformV1beta1NotebookReservationAffinity" }, "createTime": { "type": "string", "readOnly": true, "description": "Output only. Timestamp when this NotebookRuntimeTemplate was created.", "format": "google-datetime" }, "displayName": { "type": "string", "description": "Required. The display name of the NotebookRuntimeTemplate. The name can be up to 128 characters long and can consist of any UTF-8 characters." }, "eucConfig": { "$ref": "GoogleCloudAiplatformV1beta1NotebookEucConfig", "description": "EUC configuration of the NotebookRuntimeTemplate." }, "serviceAccount": { "deprecated": true, "type": "string", "description": "Deprecated: This field is ignored and the \"Vertex AI Notebook Service Account\" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. For NotebookExecutionJob, use NotebookExecutionJob.service_account instead. The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used." }, "notebookRuntimeType": { "type": "string", "enumDescriptions": [ "Unspecified notebook runtime type, NotebookRuntimeType will default to USER_DEFINED.", "runtime or template with coustomized configurations from user.", "runtime or template with system defined configurations." ], "enum": [ "NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED", "USER_DEFINED", "ONE_CLICK" ], "description": "Optional. Immutable. The type of the notebook runtime template." } }, "description": "A template that specifies runtime configurations such as machine type, runtime version, network configurations, etc. Multiple runtimes can be created from a runtime template." }, "GoogleCloudAiplatformV1beta1TunedModelCheckpoint": { "id": "GoogleCloudAiplatformV1beta1TunedModelCheckpoint", "description": "TunedModelCheckpoint for the Tuned Model of a Tuning Job.", "properties": { "endpoint": { "description": "The Endpoint resource name that the checkpoint is deployed to. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.", "type": "string" }, "checkpointId": { "type": "string", "description": "The ID of the checkpoint." }, "step": { "description": "The step of the checkpoint.", "format": "int64", "type": "string" }, "epoch": { "description": "The epoch of the checkpoint.", "type": "string", "format": "int64" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1QuestionAnsweringHelpfulnessInstance": { "properties": { "context": { "description": "Optional. Text provided as context to answer the question.", "type": "string" }, "instruction": { "type": "string", "description": "Required. The question asked and other instruction in the inference prompt." }, "prediction": { "type": "string", "description": "Required. Output of the evaluated model." }, "reference": { "description": "Optional. Ground truth used to compare against the prediction.", "type": "string" } }, "type": "object", "description": "Spec for question answering helpfulness instance.", "id": "GoogleCloudAiplatformV1beta1QuestionAnsweringHelpfulnessInstance" }, "GoogleCloudAiplatformV1beta1RougeSpec": { "id": "GoogleCloudAiplatformV1beta1RougeSpec", "type": "object", "description": "Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1.", "properties": { "rougeType": { "description": "Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.", "type": "string" }, "useStemmer": { "description": "Optional. Whether to use stemmer to compute rouge score.", "type": "boolean" }, "splitSummaries": { "description": "Optional. Whether to split summaries while using rougeLsum.", "type": "boolean" } } }, "GenaiVertexV1beta1UrlContextResultStepUrlContextResultItem": { "description": "The result of the URL context.", "properties": { "status": { "enumDescriptions": [ "", "", "", "", "" ], "enum": [ "STATUS_UNSPECIFIED", "SUCCESS", "ERROR", "PAYWALL", "UNSAFE" ], "type": "string", "description": "The status of the URL retrieval." }, "url": { "description": "The URL that was fetched.", "type": "string" } }, "type": "object", "id": "GenaiVertexV1beta1UrlContextResultStepUrlContextResultItem" }, "GoogleCloudAiplatformV1beta1SchemaPromptSpecPartList": { "description": "A list of elements and information that make up a portion of prompt.", "type": "object", "properties": { "parts": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Part" }, "type": "array", "description": "A list of elements that can be part of a prompt." } }, "id": "GoogleCloudAiplatformV1beta1SchemaPromptSpecPartList" }, "GoogleCloudAiplatformV1beta1MetricResult": { "id": "GoogleCloudAiplatformV1beta1MetricResult", "properties": { "rubricVerdicts": { "type": "array", "readOnly": true, "items": { "$ref": "GoogleCloudAiplatformV1beta1RubricVerdict" }, "description": "Output only. For rubric-based metrics, the verdicts for each rubric." }, "explanation": { "description": "Output only. The explanation for the metric result.", "readOnly": true, "type": "string" }, "error": { "description": "Output only. The error status for the metric result.", "readOnly": true, "$ref": "GoogleRpcStatus" }, "score": { "readOnly": true, "description": "Output only. The score for the metric. Please refer to each metric's documentation for the meaning of the score.", "type": "number", "format": "float" } }, "description": "Result for a single metric on a single instance.", "type": "object" }, "GoogleCloudAiplatformV1beta1ReadTensorboardUsageResponsePerUserUsageData": { "type": "object", "properties": { "username": { "type": "string", "description": "User's username" }, "viewCount": { "format": "int64", "description": "Number of times the user has read data within the Tensorboard.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1ReadTensorboardUsageResponsePerUserUsageData", "description": "Per user usage data." }, "GoogleCloudAiplatformV1beta1BoolArray": { "description": "A list of boolean values.", "properties": { "values": { "items": { "type": "boolean" }, "description": "A list of bool values.", "type": "array" } }, "id": "GoogleCloudAiplatformV1beta1BoolArray", "type": "object" }, "GenaiVertexV1beta1ThoughtSummaryDelta": { "id": "GenaiVertexV1beta1ThoughtSummaryDelta", "type": "object", "properties": { "content": { "description": "A new summary item to be added to the thought.", "$ref": "GenaiVertexV1beta1Content" } } }, "GoogleCloudAiplatformV1beta1EvaluationRunMetricLLMBasedMetricSpec": { "description": "Specification for an LLM based metric.", "properties": { "predefinedRubricGenerationSpec": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunMetricPredefinedMetricSpec", "description": "Dynamically generate rubrics using a predefined spec." }, "rubricGenerationSpec": { "description": "Dynamically generate rubrics using this specification.", "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricGenerationSpec" }, "rubricGroupKey": { "type": "string", "description": "Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance." }, "metricPromptTemplate": { "description": "Required. Template for the prompt sent to the judge model.", "type": "string" }, "judgeAutoraterConfig": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigAutoraterConfig", "description": "Optional. Optional configuration for the judge LLM (Autorater)." }, "systemInstruction": { "type": "string", "description": "Optional. System instructions for the judge model." }, "additionalConfig": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. Optional additional configuration for the metric." } }, "id": "GoogleCloudAiplatformV1beta1EvaluationRunMetricLLMBasedMetricSpec", "type": "object" }, "GoogleCloudAiplatformV1beta1PairwiseSummarizationQualitySpec": { "description": "Spec for pairwise summarization quality score metric.", "properties": { "useReference": { "description": "Optional. Whether to use instance.reference to compute pairwise summarization quality.", "type": "boolean" }, "version": { "description": "Optional. Which version to use for evaluation.", "type": "integer", "format": "int32" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1PairwiseSummarizationQualitySpec" }, "GoogleCloudAiplatformV1beta1CreateRagDataSchemaRequest": { "type": "object", "description": "Request message for VertexRagDataService.CreateRagDataSchema.", "id": "GoogleCloudAiplatformV1beta1CreateRagDataSchemaRequest", "properties": { "ragDataSchemaId": { "description": "Optional. The ID to use for the RagDataSchema, which will become the final component of the RagDataSchema's resource name if the user chooses to specify. Otherwise, RagDataSchema id will be generated by system. This value should be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.", "type": "string" }, "parent": { "type": "string", "description": "Required. The resource name of the RagCorpus to create the RagDataSchema in. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`" }, "ragDataSchema": { "$ref": "GoogleCloudAiplatformV1beta1RagDataSchema", "description": "Required. The RagDataSchema to create." } } }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation": { "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation", "properties": { "columnName": { "type": "string" } }, "description": "Training pipeline will perform following transformation functions. * The text as is--no change to case, punctuation, spelling, tense, and so on. * Convert the category name to a dictionary lookup index and generate an embedding for each index.", "type": "object" }, "GoogleCloudAiplatformV1beta1XraiAttribution": { "properties": { "smoothGradConfig": { "description": "Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf", "$ref": "GoogleCloudAiplatformV1beta1SmoothGradConfig" }, "blurBaselineConfig": { "$ref": "GoogleCloudAiplatformV1beta1BlurBaselineConfig", "description": "Config for XRAI with blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383" }, "stepCount": { "format": "int32", "type": "integer", "description": "Required. The number of steps for approximating the path integral. A good value to start is 50 and gradually increase until the sum to diff property is met within the desired error range. Valid range of its value is [1, 100], inclusively." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1XraiAttribution", "description": "An explanation method that redistributes Integrated Gradients attributions to segmented regions, taking advantage of the model's fully differentiable structure. Refer to this paper for more details: https://arxiv.org/abs/1906.02825 Supported only by image Models." }, "GoogleCloudAiplatformV1beta1BigQueryRequestSetSamplingConfig": { "description": "The sampling config.", "properties": { "samplingMethod": { "enumDescriptions": [ "Unspecified sampling method.", "Random sampling." ], "enum": [ "SAMPLING_METHOD_UNSPECIFIED", "RANDOM" ], "description": "Optional. The sampling method to use.", "type": "string" }, "samplingCount": { "type": "integer", "format": "int32", "description": "Optional. The total number of logged data to import. If available data is less than the sampling count, all data will be imported. Default is 100." }, "samplingDuration": { "format": "google-duration", "type": "string", "description": "Optional. How long to wait before sampling data from the BigQuery table. If not specified, defaults to 0." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1BigQueryRequestSetSamplingConfig" }, "GoogleCloudAiplatformV1beta1EvaluationInstanceMapInstance": { "id": "GoogleCloudAiplatformV1beta1EvaluationInstanceMapInstance", "description": "Instance data specified as a map.", "properties": { "mapInstance": { "type": "object", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData" }, "description": "Optional. Map of instance data." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployVertex": { "properties": { "multiDeployVertex": { "items": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeploy" }, "description": "Optional. One click deployment configurations.", "type": "array" } }, "type": "object", "description": "Multiple setups to deploy the PublisherModel.", "id": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployVertex" }, "GoogleCloudAiplatformV1beta1ExternalApiSimpleSearchParams": { "id": "GoogleCloudAiplatformV1beta1ExternalApiSimpleSearchParams", "type": "object", "properties": {}, "description": "The search parameters to use for SIMPLE_SEARCH spec." }, "GoogleCloudAiplatformV1beta1ImportFeatureValuesRequest": { "type": "object", "properties": { "featureTimeField": { "type": "string", "description": "Source column that holds the Feature timestamp for all Feature values in each entity." }, "disableOnlineServing": { "type": "boolean", "description": "If set, data will not be imported for online serving. This is typically used for backfilling, where Feature generation timestamps are not in the timestamp range needed for online serving." }, "avroSource": { "$ref": "GoogleCloudAiplatformV1beta1AvroSource" }, "bigquerySource": { "$ref": "GoogleCloudAiplatformV1beta1BigQuerySource" }, "featureTime": { "description": "Single Feature timestamp for all entities being imported. The timestamp must not have higher than millisecond precision.", "type": "string", "format": "google-datetime" }, "workerCount": { "description": "Specifies the number of workers that are used to write data to the Featurestore. Consider the online serving capacity that you require to achieve the desired import throughput without interfering with online serving. The value must be positive, and less than or equal to 100. If not set, defaults to using 1 worker. The low count ensures minimal impact on online serving performance.", "format": "int32", "type": "integer" }, "disableIngestionAnalysis": { "description": "If true, API doesn't start ingestion analysis pipeline.", "type": "boolean" }, "csvSource": { "$ref": "GoogleCloudAiplatformV1beta1CsvSource" }, "featureSpecs": { "items": { "$ref": "GoogleCloudAiplatformV1beta1ImportFeatureValuesRequestFeatureSpec" }, "type": "array", "description": "Required. Specifications defining which Feature values to import from the entity. The request fails if no feature_specs are provided, and having multiple feature_specs for one Feature is not allowed." }, "entityIdField": { "description": "Source column that holds entity IDs. If not provided, entity IDs are extracted from the column named entity_id.", "type": "string" } }, "description": "Request message for FeaturestoreService.ImportFeatureValues.", "id": "GoogleCloudAiplatformV1beta1ImportFeatureValuesRequest" }, "GoogleCloudAiplatformV1beta1TrajectoryInOrderMatchSpec": { "description": "Spec for TrajectoryInOrderMatch metric - returns 1 if tool calls in the reference trajectory appear in the predicted trajectory in the same order, else 0.", "type": "object", "properties": {}, "id": "GoogleCloudAiplatformV1beta1TrajectoryInOrderMatchSpec" }, "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestAgentEngineSource": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestAgentEngineSource", "description": "Source for loading Agent Engine sessions.", "properties": { "sessionIds": { "type": "array", "items": { "type": "string" }, "description": "Required. Session IDs for the Agent Engine sessions to retrieve." }, "reasoningEngineId": { "description": "Required. Reasoning Engine ID for the Agent Engine sessions.", "type": "string" }, "location": { "type": "string", "description": "Required. Location for the Agent Engine sessions." }, "projectId": { "description": "Required. Project ID for the Agent Engine sessions.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1RemoveExamplesResponse": { "type": "object", "id": "GoogleCloudAiplatformV1beta1RemoveExamplesResponse", "properties": { "exampleIds": { "description": "The IDs for the removed examples.", "items": { "type": "string" }, "type": "array" } }, "description": "Response message for ExampleStoreService.RemoveExamples." }, "GoogleCloudAiplatformV1beta1GenerateLossClustersRequest": { "type": "object", "description": "Request message for EvaluationAnalyticsService.GenerateLossClusters.", "properties": { "evaluationSet": { "description": "Reference to a persisted EvaluationSet. The service will read items from this set.", "type": "string" }, "inlineResults": { "$ref": "GoogleCloudAiplatformV1beta1GenerateLossClustersRequestEvaluationResultList", "description": "Inline evaluation results. Useful for ephemeral analysis in notebooks/SDKs where data isn't persisted." }, "configs": { "items": { "$ref": "GoogleCloudAiplatformV1beta1LossAnalysisConfig" }, "type": "array", "description": "Required. Configuration for the analysis algorithm. Analysis for multiple metrics and multiple candidates could be specified." } }, "id": "GoogleCloudAiplatformV1beta1GenerateLossClustersRequest" }, "GoogleCloudAiplatformV1beta1CreateFeatureViewOperationMetadata": { "id": "GoogleCloudAiplatformV1beta1CreateFeatureViewOperationMetadata", "type": "object", "properties": { "genericMetadata": { "description": "Operation metadata for FeatureView Create.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "description": "Details of operations that perform create FeatureView." }, "GoogleCloudAiplatformV1beta1EvaluationResult": { "id": "GoogleCloudAiplatformV1beta1EvaluationResult", "description": "Evaluation result.", "type": "object", "properties": { "evaluationRequest": { "type": "string", "description": "Required. The request item that was evaluated. Format: projects/{project}/locations/{location}/evaluationItems/{evaluation_item}" }, "metric": { "type": "string", "description": "Required. The metric that was evaluated." }, "evaluationRun": { "type": "string", "description": "Required. The evaluation run that was used to generate the result. Format: projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}" }, "metadata": { "type": "any", "description": "Optional. Metadata about the evaluation result." }, "candidateResults": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1CandidateResult" }, "description": "Optional. The results for the metric." }, "request": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationRequest", "description": "Required. The request that was evaluated." } } }, "GoogleCloudAiplatformV1beta1RayLogsSpec": { "description": "Configuration for the Ray OSS Logs.", "properties": { "disabled": { "type": "boolean", "description": "Optional. Flag to disable the export of Ray OSS logs to Cloud Logging." } }, "id": "GoogleCloudAiplatformV1beta1RayLogsSpec", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaPredictInstanceImageObjectDetectionPredictionInstance": { "id": "GoogleCloudAiplatformV1beta1SchemaPredictInstanceImageObjectDetectionPredictionInstance", "type": "object", "properties": { "content": { "description": "The image bytes or Cloud Storage URI to make the prediction on.", "type": "string" }, "mimeType": { "type": "string", "description": "The MIME type of the content of the image. Only the images in below listed MIME types are supported. - image/jpeg - image/gif - image/png - image/webp - image/bmp - image/tiff - image/vnd.microsoft.icon" } }, "description": "Prediction input format for Image Object Detection." }, "GoogleCloudAiplatformV1beta1MetricxResult": { "properties": { "score": { "format": "float", "readOnly": true, "description": "Output only. MetricX score. Range depends on version.", "type": "number" } }, "type": "object", "description": "Spec for MetricX result - calculates the MetricX score for the given instance using the version specified in the spec.", "id": "GoogleCloudAiplatformV1beta1MetricxResult" }, "GoogleCloudAiplatformV1beta1TrialContext": { "id": "GoogleCloudAiplatformV1beta1TrialContext", "type": "object", "properties": { "parameters": { "items": { "$ref": "GoogleCloudAiplatformV1beta1TrialParameter" }, "description": "If/when a Trial is generated or selected from this Context, its Parameters will match any parameters specified here. (I.e. if this context specifies parameter name:'a' int_value:3, then a resulting Trial will have int_value:3 for its parameter named 'a'.) Note that we first attempt to match existing REQUESTED Trials with contexts, and if there are no matches, we generate suggestions in the subspace defined by the parameters specified here. NOTE: a Context without any Parameters matches the entire feasible search space.", "type": "array" }, "description": { "description": "A human-readable field which can store a description of this context. This will become part of the resulting Trial's description field.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1DeployIndexResponse": { "id": "GoogleCloudAiplatformV1beta1DeployIndexResponse", "properties": { "deployedIndex": { "$ref": "GoogleCloudAiplatformV1beta1DeployedIndex", "description": "The DeployedIndex that had been deployed in the IndexEndpoint." } }, "type": "object", "description": "Response message for IndexEndpointService.DeployIndex." }, "GoogleCloudAiplatformV1beta1SchemaVisualInspectionMaskSavedQueryMetadata": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaVisualInspectionMaskSavedQueryMetadata", "properties": {} }, "GoogleCloudAiplatformV1beta1CustomOutputFormatConfig": { "properties": { "returnRawOutput": { "description": "Optional. Whether to return raw output.", "type": "boolean" } }, "id": "GoogleCloudAiplatformV1beta1CustomOutputFormatConfig", "type": "object", "description": "Spec for custom output format configuration." }, "GoogleCloudAiplatformV1beta1ServingProfile": { "properties": { "scope": { "enumDescriptions": [ "Default value. This value is unused. When users create a ServingProfile, they must choose a scope.", "The scope for Gemini Live.", "The scope for Interactions API.", "The scope for Response API." ], "enum": [ "SERVING_PROFILE_SCOPE_UNSPECIFIED", "GEMINI_LIVE", "INTERACTIONS_API", "RESPONSE_API" ], "description": "Required. The specific API this ServingProfile applies to.", "type": "string" }, "cmekConfig": { "$ref": "GoogleCloudAiplatformV1beta1ServingProfileCmekConfig", "description": "CMEK configuration for the ServingProfile." }, "updateTime": { "description": "Output only. Timestamp when the ServingProfile was last updated.", "type": "string", "readOnly": true, "format": "google-datetime" }, "displayName": { "description": "Required. The display name of the ServingProfile. The name can be up to 128 characters long and can consist of any UTF-8 characters.", "type": "string" }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. Timestamp when the ServingProfile was created.", "format": "google-datetime" }, "description": { "type": "string", "description": "Optional. The description of the ServingProfile." }, "name": { "description": "Identifier. The resource name of the ServingProfile.", "type": "string" } }, "description": "Configures the serving behavior for a resource-less GenAI serving.", "type": "object", "id": "GoogleCloudAiplatformV1beta1ServingProfile" }, "GoogleCloudAiplatformV1beta1RubricCritiqueResult": { "id": "GoogleCloudAiplatformV1beta1RubricCritiqueResult", "type": "object", "description": "Rubric critique result.", "properties": { "verdict": { "type": "boolean", "description": "Output only. Verdict for the rubric - true if the rubric is met, false otherwise.", "readOnly": true }, "rubric": { "description": "Output only. Rubric to be evaluated.", "readOnly": true, "type": "string" } } }, "GoogleCloudAiplatformV1beta1ExamplesRestrictionsNamespace": { "properties": { "namespaceName": { "description": "The namespace name.", "type": "string" }, "deny": { "items": { "type": "string" }, "description": "The list of deny tags.", "type": "array" }, "allow": { "description": "The list of allowed tags.", "type": "array", "items": { "type": "string" } } }, "id": "GoogleCloudAiplatformV1beta1ExamplesRestrictionsNamespace", "description": "Restrictions namespace for example-based explanations overrides.", "type": "object" }, "GoogleCloudAiplatformV1beta1ExplanationMetadataInputMetadata": { "description": "Metadata of the input of a feature. Fields other than InputMetadata.input_baselines are applicable only for Models that are using Vertex AI-provided images for Tensorflow.", "id": "GoogleCloudAiplatformV1beta1ExplanationMetadataInputMetadata", "type": "object", "properties": { "inputTensorName": { "description": "Name of the input tensor for this feature. Required and is only applicable to Vertex AI-provided images for Tensorflow.", "type": "string" }, "indexFeatureMapping": { "type": "array", "description": "A list of feature names for each index in the input tensor. Required when the input InputMetadata.encoding is BAG_OF_FEATURES, BAG_OF_FEATURES_SPARSE, INDICATOR.", "items": { "type": "string" } }, "visualization": { "description": "Visualization configurations for image explanation.", "$ref": "GoogleCloudAiplatformV1beta1ExplanationMetadataInputMetadataVisualization" }, "indicesTensorName": { "type": "string", "description": "Specifies the index of the values of the input tensor. Required when the input tensor is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor." }, "modality": { "type": "string", "description": "Modality of the feature. Valid values are: numeric, image. Defaults to numeric." }, "encodedTensorName": { "type": "string", "description": "Encoded tensor is a transformation of the input tensor. Must be provided if choosing Integrated Gradients attribution or XRAI attribution and the input tensor is not differentiable. An encoded tensor is generated if the input tensor is encoded by a lookup table." }, "groupName": { "description": "Name of the group that the input belongs to. Features with the same group name will be treated as one feature when computing attributions. Features grouped together can have different shapes in value. If provided, there will be one single attribution generated in Attribution.feature_attributions, keyed by the group name.", "type": "string" }, "inputBaselines": { "type": "array", "description": "Baseline inputs for this feature. If no baseline is specified, Vertex AI chooses the baseline for this feature. If multiple baselines are specified, Vertex AI returns the average attributions across them in Attribution.feature_attributions. For Vertex AI-provided Tensorflow images (both 1.x and 2.x), the shape of each baseline must match the shape of the input tensor. If a scalar is provided, we broadcast to the same shape as the input tensor. For custom images, the element of the baselines must be in the same format as the feature's input in the instance[]. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.", "items": { "type": "any" } }, "featureValueDomain": { "description": "The domain details of the input feature value. Like min/max, original mean or standard deviation if normalized.", "$ref": "GoogleCloudAiplatformV1beta1ExplanationMetadataInputMetadataFeatureValueDomain" }, "denseShapeTensorName": { "type": "string", "description": "Specifies the shape of the values of the input if the input is a sparse representation. Refer to Tensorflow documentation for more details: https://www.tensorflow.org/api_docs/python/tf/sparse/SparseTensor." }, "encodedBaselines": { "description": "A list of baselines for the encoded tensor. The shape of each baseline should match the shape of the encoded tensor. If a scalar is provided, Vertex AI broadcasts to the same shape as the encoded tensor.", "type": "array", "items": { "type": "any" } }, "encoding": { "type": "string", "enum": [ "ENCODING_UNSPECIFIED", "IDENTITY", "BAG_OF_FEATURES", "BAG_OF_FEATURES_SPARSE", "INDICATOR", "COMBINED_EMBEDDING", "CONCAT_EMBEDDING" ], "description": "Defines how the feature is encoded into the input tensor. Defaults to IDENTITY.", "enumDescriptions": [ "Default value. This is the same as IDENTITY.", "The tensor represents one feature.", "The tensor represents a bag of features where each index maps to a feature. InputMetadata.index_feature_mapping must be provided for this encoding. For example: ``` input = [27, 6.0, 150] index_feature_mapping = [\"age\", \"height\", \"weight\"] ```", "The tensor represents a bag of features where each index maps to a feature. Zero values in the tensor indicates feature being non-existent. InputMetadata.index_feature_mapping must be provided for this encoding. For example: ``` input = [2, 0, 5, 0, 1] index_feature_mapping = [\"a\", \"b\", \"c\", \"d\", \"e\"] ```", "The tensor is a list of binaries representing whether a feature exists or not (1 indicates existence). InputMetadata.index_feature_mapping must be provided for this encoding. For example: ``` input = [1, 0, 1, 0, 1] index_feature_mapping = [\"a\", \"b\", \"c\", \"d\", \"e\"] ```", "The tensor is encoded into a 1-dimensional array represented by an encoded tensor. InputMetadata.encoded_tensor_name must be provided for this encoding. For example: ``` input = [\"This\", \"is\", \"a\", \"test\", \".\"] encoded = [0.1, 0.2, 0.3, 0.4, 0.5] ```", "Select this encoding when the input tensor is encoded into a 2-dimensional array represented by an encoded tensor. InputMetadata.encoded_tensor_name must be provided for this encoding. The first dimension of the encoded tensor's shape is the same as the input tensor's shape. For example: ``` input = [\"This\", \"is\", \"a\", \"test\", \".\"] encoded = [[0.1, 0.2, 0.3, 0.4, 0.5], [0.2, 0.1, 0.4, 0.3, 0.5], [0.5, 0.1, 0.3, 0.5, 0.4], [0.5, 0.3, 0.1, 0.2, 0.4], [0.4, 0.3, 0.2, 0.5, 0.1]] ```" ] } } }, "GenaiVertexV1beta1GoogleSearchResultDelta": { "properties": { "result": { "type": "array", "items": { "$ref": "GenaiVertexV1beta1GoogleSearchResultContentGoogleSearchResult" } }, "isError": { "type": "boolean" } }, "id": "GenaiVertexV1beta1GoogleSearchResultDelta", "type": "object" }, "GoogleCloudAiplatformV1beta1DirectRawPredictResponse": { "type": "object", "properties": { "output": { "type": "string", "description": "The prediction output.", "format": "byte" } }, "id": "GoogleCloudAiplatformV1beta1DirectRawPredictResponse", "description": "Response message for PredictionService.DirectRawPredict." }, "GoogleCloudAiplatformV1beta1SandboxEnvironmentSpecComputerUseEnvironment": { "properties": {}, "type": "object", "id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentSpecComputerUseEnvironment", "description": "The computer use environment with customized settings." }, "GoogleCloudAiplatformV1beta1FunctionResponseBlob": { "id": "GoogleCloudAiplatformV1beta1FunctionResponseBlob", "properties": { "mimeType": { "type": "string", "description": "Required. The IANA standard MIME type of the source data." }, "data": { "description": "Required. Raw bytes.", "type": "string", "format": "byte" }, "displayName": { "type": "string", "description": "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." } }, "type": "object", "description": "Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field." }, "GoogleCloudAiplatformV1beta1SchemaPredictionResult": { "description": "Represents a line of JSONL in the batch prediction output file.", "properties": { "key": { "type": "string", "description": "Optional user-provided key from the input instance." }, "prediction": { "description": "The prediction result. Value is used here instead of Any so that JsonFormat does not append an extra \"@type\" field when we convert the proto to JSON and so we can represent array of objects. Do not set error if this is set.", "type": "any" }, "error": { "description": "The error result. Do not set prediction if this is set.", "$ref": "GoogleCloudAiplatformV1beta1SchemaPredictionResultError" }, "instance": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "User's input instance. Struct is used here instead of Any so that JsonFormat does not append an extra \"@type\" field when we convert the proto to JSON." } }, "id": "GoogleCloudAiplatformV1beta1SchemaPredictionResult", "type": "object" }, "GoogleCloudAiplatformV1beta1ReportRuntimeEventResponse": { "type": "object", "description": "Response message for NotebookInternalService.ReportRuntimeEvent.", "id": "GoogleCloudAiplatformV1beta1ReportRuntimeEventResponse", "properties": { "idleShutdownMessage": { "description": "If the idle shutdown is blocked by CP, CP will send the block message. Otherwise, this field is not set.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1CorroborateContentResponse": { "type": "object", "properties": { "corroborationScore": { "description": "Confidence score of corroborating content. Value is [0,1] with 1 is the most confidence.", "format": "float", "type": "number" }, "claims": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Claim" }, "description": "Claims that are extracted from the input content and facts that support the claims." } }, "id": "GoogleCloudAiplatformV1beta1CorroborateContentResponse", "description": "Response message for CorroborateContent." }, "GoogleCloudAiplatformV1beta1GcsSource": { "type": "object", "properties": { "uris": { "type": "array", "items": { "type": "string" }, "description": "Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards." } }, "id": "GoogleCloudAiplatformV1beta1GcsSource", "description": "The Google Cloud Storage location for the input content." }, "GoogleCloudAiplatformV1beta1FeaturestoreMonitoringConfigThresholdConfig": { "type": "object", "description": "The config for Featurestore Monitoring threshold.", "properties": { "value": { "description": "Specify a threshold value that can trigger the alert. 1. For categorical feature, the distribution distance is calculated by L-inifinity norm. 2. For numerical feature, the distribution distance is calculated by Jensen–Shannon divergence. Each feature must have a non-zero threshold if they need to be monitored. Otherwise no alert will be triggered for that feature.", "type": "number", "format": "double" } }, "id": "GoogleCloudAiplatformV1beta1FeaturestoreMonitoringConfigThresholdConfig" }, "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfig": { "id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfig", "type": "object", "properties": { "dnsPeeringConfigs": { "description": "Optional. DNS peering configurations that allow sandbox egress to resolve customer-internal domains via the customer VPC.", "items": { "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig" }, "type": "array" }, "networkAttachment": { "type": "string", "description": "Optional. The name of the customer VPC `NetworkAttachment` used to draw a PSC interface IP into the customer VPC for sandbox egress." }, "internetAccess": { "description": "Optional. Whether to allow internet access.", "type": "boolean" } }, "description": "Configuration for egress control of sandbox instances." }, "GoogleCloudAiplatformV1beta1ModelMonitoringNotificationSpecNotificationChannelConfig": { "properties": { "notificationChannel": { "description": "Resource names of the NotificationChannels. Must be of the format `projects//notificationChannels/`", "type": "string" } }, "description": "Google Cloud Notification Channel config.", "type": "object", "id": "GoogleCloudAiplatformV1beta1ModelMonitoringNotificationSpecNotificationChannelConfig" }, "GoogleCloudAiplatformV1beta1RetrievalMetadata": { "type": "object", "properties": { "googleSearchDynamicRetrievalScore": { "description": "Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search.", "type": "number", "format": "float" } }, "description": "Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled.", "id": "GoogleCloudAiplatformV1beta1RetrievalMetadata" }, "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExample": { "properties": { "conversationSource": { "description": "A conversation source for the example.", "$ref": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSource" }, "generatedMemories": { "items": { "$ref": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExampleGeneratedMemory" }, "type": "array", "description": "Optional. Represents the memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation." } }, "description": "An example of how to generate memories for a particular scope.", "type": "object", "id": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExample" }, "GoogleCloudAiplatformV1beta1CreateFeatureOnlineStoreOperationMetadata": { "id": "GoogleCloudAiplatformV1beta1CreateFeatureOnlineStoreOperationMetadata", "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "Operation metadata for FeatureOnlineStore." } }, "type": "object", "description": "Details of operations that perform create FeatureOnlineStore." }, "GoogleCloudAiplatformV1beta1UpdateIndexOperationMetadata": { "type": "object", "properties": { "nearestNeighborSearchOperationMetadata": { "description": "The operation metadata with regard to Matching Engine Index operation.", "$ref": "GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadata" }, "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "The operation generic information." } }, "id": "GoogleCloudAiplatformV1beta1UpdateIndexOperationMetadata", "description": "Runtime operation information for IndexService.UpdateIndex." }, "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigRanking": { "id": "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigRanking", "properties": { "rankService": { "$ref": "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigRankingRankService", "description": "Config for Rank Service." } }, "description": "Config for ranking and reranking.", "type": "object" }, "GoogleCloudAiplatformV1beta1ToolParallelAiSearch": { "description": "ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding.", "properties": { "customConfigs": { "description": "Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { \"source_policy\": { \"include_domains\": [\"google.com\", \"wikipedia.org\"], \"exclude_domains\": [\"example.com\"] }, \"fetch_policy\": { \"max_age_seconds\": 3600 } }", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "enableDataRetention": { "description": "Optional. Deprecated: Use `enable_zero_data_retention` instead. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is \"false\" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is \"true\", the Parallel Web Search for Grounding - ZDR subscription will be used.", "type": "boolean", "deprecated": true }, "apiKey": { "description": "Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details.", "type": "string" }, "enableZeroDataRetention": { "description": "Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is \"false\" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is \"true\", the Parallel Web Search for Grounding - ZDR subscription will be used.", "type": "boolean" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ToolParallelAiSearch" }, "GoogleCloudAiplatformV1beta1MigrateResourceResponse": { "id": "GoogleCloudAiplatformV1beta1MigrateResourceResponse", "properties": { "model": { "description": "Migrated Model's resource name.", "type": "string" }, "dataset": { "type": "string", "description": "Migrated Dataset's resource name." }, "migratableResource": { "$ref": "GoogleCloudAiplatformV1beta1MigratableResource", "description": "Before migration, the identifier in ml.googleapis.com, automl.googleapis.com or datalabeling.googleapis.com." } }, "description": "Describes a successfully migrated resource.", "type": "object" }, "GoogleCloudAiplatformV1beta1RagFileParsingConfigLlmParser": { "description": "Specifies the LLM parsing for RagFiles.", "type": "object", "properties": { "modelName": { "type": "string", "description": "The name of a LLM model used for parsing. Format: * `projects/{project_id}/locations/{location}/publishers/{publisher}/models/{model}`" }, "customParsingPrompt": { "description": "The prompt to use for parsing. If not specified, a default prompt will be used.", "type": "string" }, "globalMaxParsingRequestsPerMin": { "format": "int32", "type": "integer", "description": "The maximum number of requests the job is allowed to make to the LLM model per minute in this project. Consult https://cloud.google.com/vertex-ai/generative-ai/docs/quotas and your document size to set an appropriate value here. If this value is not specified, max_parsing_requests_per_min will be used by indexing pipeline job as the global limit." }, "maxParsingRequestsPerMin": { "type": "integer", "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" } }, "id": "GoogleCloudAiplatformV1beta1RagFileParsingConfigLlmParser" }, "GoogleCloudAiplatformV1beta1MutateDeployedIndexOperationMetadata": { "type": "object", "id": "GoogleCloudAiplatformV1beta1MutateDeployedIndexOperationMetadata", "description": "Runtime operation information for IndexEndpointService.MutateDeployedIndex.", "properties": { "genericMetadata": { "description": "The operation generic information.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" }, "deployedIndexId": { "type": "string", "description": "The unique index id specified by user" } } }, "GoogleCloudAiplatformV1beta1SandboxEnvironmentSnapshot": { "id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentSnapshot", "type": "object", "properties": { "updateTime": { "description": "Output only. The timestamp when this SandboxEnvironment was most recently updated.", "type": "string", "format": "google-datetime", "readOnly": true }, "name": { "type": "string", "description": "Identifier. The resource name of the SandboxEnvironmentSnapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`" }, "expireTime": { "description": "Optional. Timestamp in UTC of when this SandboxEnvironmentSnapshot is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.", "format": "google-datetime", "type": "string" }, "sizeBytes": { "readOnly": true, "type": "string", "format": "int64", "description": "Optional. Output only. Size of the snapshot data in bytes." }, "parentSnapshot": { "type": "string", "readOnly": true, "description": "Output only. The resource name of the parent SandboxEnvironmentSnapshot. Empty if this is a root Snapshot (the first snapshot from a newly created sandbox). Can be used to reconstruct the whole ancestry tree of snapshots." }, "createTime": { "description": "Output only. The timestamp when this SandboxEnvironmentSnapshot was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "postSnapshotAction": { "enumDescriptions": [ "The default value. This value is unused.", "Sandbox environment will continue to run after snapshot is taken.", "Sandbox environment will be paused after snapshot is taken." ], "enum": [ "POST_SNAPSHOT_ACTION_UNSPECIFIED", "RUNNING", "PAUSE" ], "type": "string", "description": "Optional. Input only. Action to take on the source SandboxEnvironment after the snapshot is taken. This field is only used in CreateSandboxEnvironmentSnapshotRequest and it is not stored in the resource." }, "owner": { "type": "string", "description": "Optional. Owner information for this sandbox snapshot. Different owners will have isolations on snapshot storage and identity. If not set, snapshot will be created as the default owner." }, "ttl": { "description": "Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL.", "format": "google-duration", "type": "string" }, "sourceSandboxEnvironment": { "type": "string", "description": "Required. The resource name of the source SandboxEnvironment this snapshot was taken from." }, "displayName": { "description": "Required. The display name of the SandboxEnvironmentSnapshot.", "type": "string" }, "useGkeTd": { "readOnly": true, "description": "Output only. Whether the source SandboxEnvironment uses the GKE TD pool.", "type": "boolean" } }, "description": "SandboxEnvironmentSnapshot is a snapshot of the SandboxEnvironment." }, "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeploy": { "description": "Model metadata that is needed for UploadModel or DeployModel/CreateEndpoint requests.", "id": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeploy", "properties": { "title": { "description": "Required. The title of the regional resource reference.", "type": "string" }, "containerSpec": { "description": "Optional. The specification of the container that is to be used when deploying this Model in Vertex AI. Not present for Large Models.", "$ref": "GoogleCloudAiplatformV1beta1ModelContainerSpec" }, "modelDisplayName": { "description": "Optional. Default model display name.", "type": "string" }, "largeModelReference": { "$ref": "GoogleCloudAiplatformV1beta1LargeModelReference", "description": "Optional. Large model reference. When this is set, model_artifact_spec is not needed." }, "deployMetadata": { "description": "Optional. Metadata information about this deployment config.", "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployDeployMetadata" }, "dedicatedResources": { "$ref": "GoogleCloudAiplatformV1beta1DedicatedResources", "description": "A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration." }, "publicArtifactUri": { "type": "string", "description": "Optional. The signed URI for ephemeral Cloud Storage access to model artifact." }, "sharedResources": { "description": "The resource name of the shared DeploymentResourcePool to deploy on. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", "type": "string" }, "artifactUri": { "description": "Optional. The path to the directory containing the Model artifact and any of its supporting files.", "type": "string" }, "deployTaskName": { "description": "Optional. The name of the deploy task (e.g., \"text to image generation\").", "type": "string" }, "automaticResources": { "description": "A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.", "$ref": "GoogleCloudAiplatformV1beta1AutomaticResources" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1RebaseTunedModelRequest": { "description": "Request message for GenAiTuningService.RebaseTunedModel.", "properties": { "deployToSameEndpoint": { "type": "boolean", "description": "Optional. By default, rebasing a model creates a new endpoint for the new model. If this flag is set to true, the new model will be deployed to the same endpoint as the original model. WARNING: If you deploy to the same endpoint, the original model will be un-deployed and replaced by the new model." }, "tunedModelRef": { "description": "Required. A reference to the tuned model to rebase.", "$ref": "GoogleCloudAiplatformV1beta1TunedModelRef" }, "tuningJob": { "description": "Optional. The tuning job to be updated. Users can use this field to overwrite tuning configs.", "$ref": "GoogleCloudAiplatformV1beta1TuningJob" }, "artifactDestination": { "$ref": "GoogleCloudAiplatformV1beta1GcsDestination", "description": "Optional. The Google Cloud Storage location to write the artifacts to." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1RebaseTunedModelRequest" }, "GoogleCloudAiplatformV1beta1PurgeArtifactsMetadata": { "type": "object", "id": "GoogleCloudAiplatformV1beta1PurgeArtifactsMetadata", "description": "Details of operations that perform MetadataService.PurgeArtifacts.", "properties": { "genericMetadata": { "description": "Operation metadata for purging Artifacts.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } } }, "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigConsolidationConfig": { "description": "Represents configuration for customizing how memories are consolidated.", "type": "object", "properties": { "revisionsPerCandidateCount": { "type": "integer", "description": "Optional. Represents the maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered.", "format": "int32" } }, "id": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigConsolidationConfig" }, "CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig": { "id": "CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig", "type": "object", "description": "Configuration for spatial alignment.", "properties": { "enable": { "description": "Optional. If true, enable alignment.", "type": "boolean" } } }, "GoogleCloudAiplatformV1beta1A2ATaskRecordStatusUpdate": { "type": "object", "id": "GoogleCloudAiplatformV1beta1A2ATaskRecordStatusUpdate", "description": "An event payload that updates the task's state and optional status message.", "properties": { "timestamp": { "type": "string", "description": "Optional. The time at which the status change occurred.", "format": "google-datetime" }, "message": { "description": "Optional. The status message associated with the state change.", "$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordMessage" }, "state": { "enumDescriptions": [ "The task is in an unknown or indeterminate state.", "Indicates that a task has been successfully submitted and acknowledged.", "Indicates that a task is actively being processed by the agent.", "Indicates that a task has finished successfully. This is a terminal state.", "Indicates that a task has finished with an error. This is a terminal state.", "Indicates that a task was canceled before completion. This is a terminal state.", "Indicates that the agent requires additional user input to proceed. This is an interrupted state.", "Indicates that the agent has decided to not perform the task. This may be done during initial task creation or later once an agent has determined it can't or won't proceed. This is a terminal state.", "Indicates that authentication is required to proceed. This is an interrupted state." ], "description": "Required. The new state of the task.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "TASK_STATE_SUBMITTED", "TASK_STATE_WORKING", "TASK_STATE_COMPLETED", "TASK_STATE_FAILED", "TASK_STATE_CANCELED", "TASK_STATE_INPUT_REQUIRED", "TASK_STATE_REJECTED", "TASK_STATE_AUTH_REQUIRED" ] } } }, "GenaiVertexV1beta1DeepResearchAgentConfig": { "type": "object", "description": "Configuration for the Deep Research agent.", "id": "GenaiVertexV1beta1DeepResearchAgentConfig", "properties": { "thinkingSummaries": { "description": "Whether to include thought summaries in the response.", "enumDescriptions": [ "Default value. This value is unused.", "Auto thinking summaries.", "No thinking summaries." ], "enum": [ "THINKING_SUMMARIES_UNSPECIFIED", "THINKING_SUMMARIES_AUTO", "THINKING_SUMMARIES_NONE" ], "type": "string" }, "enableBigqueryTool": { "type": "boolean", "description": "Enables bigquery tool for the Deep Research agent." }, "collaborativePlanning": { "description": "Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn.", "type": "boolean" }, "visualization": { "type": "string", "description": "Whether to include visualizations in the response.", "enum": [ "UNSPECIFIED", "OFF", "AUTO" ], "enumDescriptions": [ "The default visualization mode. Will default to AUTO.", "Do not include visualizations.", "Automatically include visualizations." ] } } }, "GoogleCloudAiplatformV1beta1TrajectoryExactMatchInput": { "type": "object", "properties": { "metricSpec": { "$ref": "GoogleCloudAiplatformV1beta1TrajectoryExactMatchSpec", "description": "Required. Spec for TrajectoryExactMatch metric." }, "instances": { "items": { "$ref": "GoogleCloudAiplatformV1beta1TrajectoryExactMatchInstance" }, "type": "array", "description": "Required. Repeated TrajectoryExactMatch instance." } }, "id": "GoogleCloudAiplatformV1beta1TrajectoryExactMatchInput", "description": "Instances and metric spec for TrajectoryExactMatch metric." }, "GenaiVertexV1beta1ModelInteraction": { "type": "object", "description": "Interaction for generating the completion using models.", "id": "GenaiVertexV1beta1ModelInteraction", "properties": { "model": { "description": "The name of the `Model` used for generating the completion.", "type": "string" }, "generationConfig": { "$ref": "GenaiVertexV1beta1GenerationConfig", "description": "Input only. Configuration parameters for the model interaction." } } }, "GoogleCloudAiplatformV1beta1DiskSpec": { "type": "object", "properties": { "bootDiskType": { "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" }, "bootDiskSizeGb": { "description": "Size in GB of the boot disk (default is 100GB).", "format": "int32", "type": "integer" } }, "id": "GoogleCloudAiplatformV1beta1DiskSpec", "description": "Represents the spec of disk options." }, "GoogleCloudAiplatformV1beta1UrlMetadata": { "type": "object", "description": "The metadata for a single URL retrieval.", "id": "GoogleCloudAiplatformV1beta1UrlMetadata", "properties": { "retrievedUrl": { "description": "The URL retrieved by the tool.", "type": "string" }, "urlRetrievalStatus": { "enum": [ "URL_RETRIEVAL_STATUS_UNSPECIFIED", "URL_RETRIEVAL_STATUS_SUCCESS", "URL_RETRIEVAL_STATUS_ERROR" ], "enumDescriptions": [ "Default value. This value is unused.", "The URL was retrieved successfully.", "The URL retrieval failed." ], "type": "string", "description": "The status of the URL retrieval." } } }, "GoogleCloudAiplatformV1beta1GenerationConfigModelConfig": { "id": "GoogleCloudAiplatformV1beta1GenerationConfigModelConfig", "type": "object", "description": "Config for model selection.", "properties": { "featureSelectionPreference": { "type": "string", "description": "Required. Feature selection preference.", "enumDescriptions": [ "Unspecified feature selection preference.", "Prefer higher quality over lower cost.", "Balanced feature selection preference.", "Prefer lower cost over higher quality." ], "enum": [ "FEATURE_SELECTION_PREFERENCE_UNSPECIFIED", "PRIORITIZE_QUALITY", "BALANCED", "PRIORITIZE_COST" ] } } }, "GoogleCloudAiplatformV1beta1VeoTuningSpec": { "description": "Tuning Spec for Veo Model Tuning.", "id": "GoogleCloudAiplatformV1beta1VeoTuningSpec", "properties": { "hyperParameters": { "description": "Optional. Hyperparameters for Veo.", "$ref": "GoogleCloudAiplatformV1beta1VeoHyperParameters" }, "trainingDatasetUri": { "description": "Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.", "type": "string" }, "validationDatasetUri": { "description": "Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ModelMonitoringStatsDataPointTypedValue": { "properties": { "doubleValue": { "type": "number", "description": "Double.", "format": "double" }, "distributionValue": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringStatsDataPointTypedValueDistributionDataValue", "description": "Distribution." } }, "type": "object", "description": "Typed value of the statistics.", "id": "GoogleCloudAiplatformV1beta1ModelMonitoringStatsDataPointTypedValue" }, "GoogleCloudAiplatformV1beta1ReplicatedVoiceConfig": { "id": "GoogleCloudAiplatformV1beta1ReplicatedVoiceConfig", "type": "object", "properties": { "mimeType": { "description": "Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.", "type": "string" }, "voiceSampleAudio": { "type": "string", "description": "Optional. The sample of the custom voice.", "format": "byte" } }, "description": "The configuration for the replicated voice to use." }, "GoogleCloudAiplatformV1beta1AsyncRetrieveContextsRequest": { "type": "object", "id": "GoogleCloudAiplatformV1beta1AsyncRetrieveContextsRequest", "description": "Request message for VertexRagService.AsyncRetrieveContexts.", "properties": { "query": { "$ref": "GoogleCloudAiplatformV1beta1RagQuery", "description": "Required. Single RAG retrieve query." }, "tools": { "type": "array", "description": "Optional. The tools to use for AskContexts.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Tool" } } } }, "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateCustomContainerSpec": { "type": "object", "properties": { "imageUri": { "description": "Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica.", "type": "string" } }, "description": "Specification for deploying from a custom container image.", "id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateCustomContainerSpec" }, "GoogleCloudAiplatformV1beta1RuntimeArtifact": { "id": "GoogleCloudAiplatformV1beta1RuntimeArtifact", "properties": { "uri": { "type": "string", "description": "The URI of the artifact." }, "type": { "description": "The type of the artifact.", "$ref": "GoogleCloudAiplatformV1beta1ArtifactTypeSchema" }, "properties": { "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1Value" }, "deprecated": true, "description": "The properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.", "type": "object" }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Properties of the Artifact.", "type": "object" }, "name": { "description": "The name of an artifact.", "type": "string" }, "customProperties": { "type": "object", "deprecated": true, "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1Value" }, "description": "The custom properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead." } }, "type": "object", "description": "The definition of a runtime artifact." }, "GoogleCloudAiplatformV1beta1GroundednessResult": { "type": "object", "id": "GoogleCloudAiplatformV1beta1GroundednessResult", "properties": { "explanation": { "type": "string", "readOnly": true, "description": "Output only. Explanation for groundedness score." }, "score": { "format": "float", "type": "number", "description": "Output only. Groundedness score.", "readOnly": true }, "confidence": { "readOnly": true, "type": "number", "format": "float", "description": "Output only. Confidence for groundedness score." } }, "description": "Spec for groundedness result." }, "GoogleCloudAiplatformV1beta1PreTunedModel": { "properties": { "tunedModelName": { "description": "The resource name of the Model. E.g., a model resource name with a specified version id or alias: `projects/{project}/locations/{location}/models/{model}@{version_id}` `projects/{project}/locations/{location}/models/{model}@{alias}` Or, omit the version id to use the default version: `projects/{project}/locations/{location}/models/{model}`", "type": "string" }, "checkpointId": { "description": "Optional. The source checkpoint id. If not specified, the default checkpoint will be used.", "type": "string" }, "baseModel": { "type": "string", "description": "Output only. The name of the base model this PreTunedModel was tuned from.", "readOnly": true } }, "id": "GoogleCloudAiplatformV1beta1PreTunedModel", "description": "A pre-tuned model for continuous tuning.", "type": "object" }, "GoogleCloudAiplatformV1beta1EvaluationMetric": { "properties": { "metric": { "description": "Optional. The metric configuration. Only LLMMetric and CustomCodeExecutionMetric are supported.", "$ref": "GoogleCloudAiplatformV1beta1Metric" }, "name": { "type": "string", "description": "Identifier. The resource name of the EvaluationMetric. Format: `projects/{project}/locations/{location}/evaluationMetrics/{evaluation_metric}`" }, "updateTime": { "readOnly": true, "type": "string", "description": "Output only. The time when the EvaluationMetric was last updated.", "format": "google-datetime" }, "displayName": { "type": "string", "description": "Required. The user-friendly display name for the EvaluationMetric." }, "gcsUri": { "type": "string", "description": "Optional. The Google Cloud Storage URI that stores the metric specification.." }, "labels": { "additionalProperties": { "type": "string" }, "description": "Optional. Labels for the evaluation metric.", "type": "object" }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time when the EvaluationMetric was created.", "readOnly": true }, "encryptionSpec": { "description": "Optional. Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key.", "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec" }, "description": { "type": "string", "description": "Optional. A description of the EvaluationMetric." } }, "id": "GoogleCloudAiplatformV1beta1EvaluationMetric", "type": "object", "description": "EvaluationMetric is a resource that represents a reusable metric configuration." }, "GoogleCloudAiplatformV1beta1CachedContent": { "description": "A resource used in LLM queries for users to explicitly specify what to cache and how to cache.", "properties": { "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. When the cache entry was last updated in UTC time.", "readOnly": true }, "model": { "type": "string", "description": "Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL}" }, "usageMetadata": { "readOnly": true, "description": "Output only. Metadata on the usage of the cached content.", "$ref": "GoogleCloudAiplatformV1beta1CachedContentUsageMetadata" }, "tools": { "description": "Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Tool" } }, "systemInstruction": { "description": "Optional. Input only. Immutable. Developer set system instruction. Currently, text only", "$ref": "GoogleCloudAiplatformV1beta1Content" }, "expireTime": { "format": "google-datetime", "description": "Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input.", "type": "string" }, "ttl": { "type": "string", "description": "Input only. The TTL for this resource. The expiration time is computed: now + TTL.", "format": "google-duration" }, "displayName": { "type": "string", "description": "Optional. Immutable. The user-generated meaningful display name of the cached content." }, "contents": { "type": "array", "description": "Optional. Input only. Immutable. The content to cache", "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" } }, "toolConfig": { "$ref": "GoogleCloudAiplatformV1beta1ToolConfig", "description": "Optional. Input only. Immutable. Tool config. This config is shared for all tools" }, "createTime": { "type": "string", "readOnly": true, "description": "Output only. Creation time of the cache entry.", "format": "google-datetime" }, "name": { "type": "string", "description": "Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}" }, "encryptionSpec": { "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.", "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec" } }, "id": "GoogleCloudAiplatformV1beta1CachedContent", "type": "object" }, "GenaiVertexV1beta1Field": { "type": "object", "id": "GenaiVertexV1beta1Field", "properties": { "name": { "type": "string" }, "value": { "$ref": "GenaiVertexV1beta1Value" } }, "description": "Represents a single field in a struct." }, "GoogleCloudAiplatformV1beta1EvaluationPromptPromptTemplateData": { "description": "Message to hold a prompt template and the values to populate the template.", "type": "object", "id": "GoogleCloudAiplatformV1beta1EvaluationPromptPromptTemplateData", "properties": { "values": { "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1Content" }, "type": "object", "description": "The values for fields in the prompt template." } } }, "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestInlineSource": { "description": "Wrapper for inline data.", "type": "object", "id": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestInlineSource", "properties": { "content": { "format": "byte", "description": "Required. The content of the inline data.", "type": "string" }, "importSchemaConfig": { "$ref": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestImportSchemaConfig", "description": "Required. Schema configuration for the inline data." } } }, "GoogleCloudAiplatformV1beta1DeployedModelRef": { "type": "object", "id": "GoogleCloudAiplatformV1beta1DeployedModelRef", "properties": { "endpoint": { "description": "Immutable. A resource name of an Endpoint.", "type": "string" }, "deployedModelId": { "description": "Immutable. An ID of a DeployedModel in the above Endpoint.", "type": "string" }, "checkpointId": { "description": "Immutable. The ID of the Checkpoint deployed in the DeployedModel.", "type": "string" } }, "description": "Points to a DeployedModel." }, "GoogleCloudAiplatformV1beta1BatchReadFeatureValuesOperationMetadata": { "id": "GoogleCloudAiplatformV1beta1BatchReadFeatureValuesOperationMetadata", "description": "Details of operations that batch reads Feature values.", "properties": { "genericMetadata": { "description": "Operation metadata for Featurestore batch read Features values.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1CustomOutput": { "id": "GoogleCloudAiplatformV1beta1CustomOutput", "type": "object", "properties": { "rawOutputs": { "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1RawOutput", "description": "Output only. List of raw output strings." } }, "description": "Spec for custom output." }, "GoogleCloudAiplatformV1beta1FeatureViewBigtableMetadata": { "type": "object", "properties": { "readAppProfile": { "readOnly": true, "type": "string", "description": "Output only. The Bigtable App Profile to use for reading from Bigtable." } }, "id": "GoogleCloudAiplatformV1beta1FeatureViewBigtableMetadata", "description": "Metadata for the Cloud Bigtable that supports directly interacting Bigtable instances." }, "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecAgentConfigSource": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecAgentConfigSource", "description": "Specification for the deploying from agent config.", "properties": { "adkConfig": { "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecAgentConfigSourceAdkConfig", "description": "Required. The ADK configuration." }, "inlineSource": { "description": "Optional. Any additional files needed to interpret the config. If a `requirements.txt` file is present in the `inline_source`, the corresponding packages will be installed. If no `requirements.txt` file is present in `inline_source`, then the latest version of `google-adk` will be installed for interpreting the ADK config.", "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecInlineSource" } } }, "GoogleCloudAiplatformV1beta1SchemaImageSegmentationAnnotationPolylineAnnotation": { "type": "object", "description": "Represents a polyline in image.", "id": "GoogleCloudAiplatformV1beta1SchemaImageSegmentationAnnotationPolylineAnnotation", "properties": { "annotationSpecId": { "description": "The resource Id of the AnnotationSpec that this Annotation pertains to.", "type": "string" }, "displayName": { "description": "The display name of the AnnotationSpec that this Annotation pertains to.", "type": "string" }, "vertexes": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaVertex" }, "description": "The vertexes are connected one by one and the last vertex in not connected to the first one." } } }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionCustomTask": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionCustomTask", "description": "A TrainingJob that trains a custom code Model.", "properties": { "metadata": { "description": "The metadata information.", "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionCustomJobMetadata" }, "inputs": { "$ref": "GoogleCloudAiplatformV1beta1CustomJobSpec", "description": "The input parameters of this CustomTask." } } }, "GoogleCloudAiplatformV1beta1ImageConfig": { "description": "Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people.", "id": "GoogleCloudAiplatformV1beta1ImageConfig", "type": "object", "properties": { "imageSize": { "description": "Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`.", "type": "string" }, "personGeneration": { "description": "Optional. Controls whether the model can generate people.", "type": "string", "enum": [ "PERSON_GENERATION_UNSPECIFIED", "ALLOW_ALL", "ALLOW_ADULT", "ALLOW_NONE" ], "enumDescriptions": [ "The default behavior is unspecified. The model will decide whether to generate images of people.", "Allows the model to generate images of people, including adults and children.", "Allows the model to generate images of adults, but not children.", "Prevents the model from generating images of people." ] }, "imageOutputOptions": { "description": "Optional. The image output format for generated images.", "$ref": "GoogleCloudAiplatformV1beta1ImageConfigImageOutputOptions" }, "aspectRatio": { "type": "string", "description": "Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: \"1:1\" \"2:3\", \"3:2\" \"3:4\", \"4:3\" \"4:5\", \"5:4\" \"9:16\", \"16:9\" \"21:9\"" }, "prominentPeople": { "enumDescriptions": [ "Unspecified value. The model will proceed with the default behavior, which is to allow generation of prominent people.", "Allows the model to generate images of prominent people.", "Prevents the model from generating images of prominent people." ], "enum": [ "PROMINENT_PEOPLE_UNSPECIFIED", "ALLOW_PROMINENT_PEOPLE", "BLOCK_PROMINENT_PEOPLE" ], "type": "string", "description": "Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people." } } }, "GoogleCloudAiplatformV1beta1PublisherModelCallToActionOpenFineTuningPipelines": { "properties": { "fineTuningPipelines": { "items": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences" }, "description": "Required. Regional resource references to fine tuning pipelines.", "type": "array" } }, "id": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionOpenFineTuningPipelines", "description": "Open fine tuning pipelines.", "type": "object" }, "GoogleCloudAiplatformV1beta1EnableModelResponse": { "id": "GoogleCloudAiplatformV1beta1EnableModelResponse", "type": "object", "properties": { "enablementState": { "description": "Output only. The result of the model enablement.", "readOnly": true, "type": "string", "enumDescriptions": [ "The PublisherModel enable status is unclear. The API will default to this value.", "The PublisherModel is enabled successfully.", "The PublisherModel is failed to enable" ], "enum": [ "ENABLEMENT_STATE_UNSPECIFIED", "ENABLEMENT_STATE_SUCCEEDED", "ENABLEMENT_STATE_FAILED" ] }, "publisherEndpoint": { "type": "string", "readOnly": true, "description": "Output only. The publisher endpoint that the project is enabled for. Format: `projects/{project}/locations/{location}/publishers/{publisher}/models/{publisher_model}`" } }, "description": "Response message for ModelGardenService.EnableModel." }, "GoogleCloudAiplatformV1beta1PurgeMemoriesRequest": { "type": "object", "properties": { "filterGroups": { "description": "Optional. Metadata filters that will be applied to the memories to be purged. Filters are defined using disjunctive normal form (OR of ANDs). For example: `filter_groups: [{filters: [{key: \"author\", value: {string_value: \"agent 123\"}, op: EQUAL}]}, {filters: [{key: \"label\", value: {string_value: \"travel\"}, op: EQUAL}, {key: \"author\", value: {string_value: \"agent 321\"}, op: EQUAL}]}]` would be equivalent to the logical expression: `(metadata.author = \"agent 123\" OR (metadata.label = \"travel\" AND metadata.author = \"agent 321\"))`.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1MemoryConjunctionFilter" } }, "filter": { "type": "string", "description": "Required. The standard list filter to determine which memories to purge. More detail in [AIP-160](https://google.aip.dev/160)." }, "force": { "description": "Optional. If true, the memories will actually be purged. If false, the purge request will be validated but not executed.", "type": "boolean" } }, "id": "GoogleCloudAiplatformV1beta1PurgeMemoriesRequest", "description": "Request message for MemoryBankService.PurgeMemories." }, "GoogleCloudAiplatformV1beta1NasTrialDetail": { "description": "Represents a NasTrial details along with its parameters. If there is a corresponding train NasTrial, the train NasTrial is also returned.", "type": "object", "properties": { "name": { "readOnly": true, "description": "Output only. Resource name of the NasTrialDetail.", "type": "string" }, "parameters": { "description": "The parameters for the NasJob NasTrial.", "type": "string" }, "trainTrial": { "description": "The train NasTrial corresponding to search_trial. Only populated if search_trial is used for training.", "$ref": "GoogleCloudAiplatformV1beta1NasTrial" }, "searchTrial": { "$ref": "GoogleCloudAiplatformV1beta1NasTrial", "description": "The requested search NasTrial." } }, "id": "GoogleCloudAiplatformV1beta1NasTrialDetail" }, "GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate": { "id": "GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate", "description": "Contains aggregated statistics for one MonitoredAgent.", "type": "object", "properties": { "agentStatus": { "type": "string", "description": "Output only. The enablement state of the MonitoredAgent (for example, ACTIVE, DISABLED, or ENABLING).", "enumDescriptions": [ "The default value. This value is used if the state is omitted.", "The agent is successfully enabled and active.", "The agent is in the process of being enabled.", "The agent is disabled." ], "readOnly": true, "enum": [ "ENABLEMENT_STATE_UNSPECIFIED", "ACTIVE", "ENABLING", "DISABLED" ] }, "agentType": { "description": "Output only. The runtime the agent is hosted on (for example, `CLOUD_RUN_SERVICE`). `AGENT_TYPE_UNSPECIFIED` means the runtime is unknown to this service, which is distinct from `AGENT_TYPE_OTHER` (known, and not one of the enumerated Google Cloud runtimes).", "enumDescriptions": [ "The default value, used when the runtime type is unspecified.", "The agent runs on the Gemini Enterprise Agent Platform Agent Runtime (Reasoning Engine).", "The agent runs as a Google Cloud Run service.", "The agent runs as a workload on Google Kubernetes Engine.", "The agent runs on a Compute Engine instance.", "The agent runs on another runtime, such as a self-hosted, on-premises, or non-Google Cloud environment, or any runtime not represented by the values above." ], "enum": [ "AGENT_TYPE_UNSPECIFIED", "REASONING_ENGINE", "CLOUD_RUN_SERVICE", "GKE_WORKLOAD", "GCE_INSTANCE", "AGENT_TYPE_OTHER" ], "readOnly": true, "type": "string" }, "monitoredAgent": { "type": "string", "description": "The MonitoredAgent resource name. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}`" }, "agentDisplayName": { "readOnly": true, "description": "Output only. The human-readable display name of the MonitoredAgent.", "type": "string" }, "location": { "readOnly": true, "description": "Output only. The Google Cloud location (region) of the agent (for example, `us-central1`). Empty when the agent is not enrolled or its location is unknown.", "type": "string" }, "anomalousSessionsCount": { "description": "The number of anomalous (SESSION_STATE_FLAGGED) sessions for this agent.", "format": "int32", "type": "integer" }, "totalSessionsCount": { "type": "integer", "format": "int32", "description": "The number of analyzed sessions for this agent matched by the request." }, "latestSessionTime": { "description": "The latest session update_time observed for this agent.", "format": "google-datetime", "type": "string" }, "severities": { "type": "object", "description": "Map of severity level (string representation of Severity) to detector summaries aggregated across all sessions for this agent. The key is the string representation of Severity enum: \"SEVERITY_UNSPECIFIED\", \"SEVERITY_CRITICAL\", \"SEVERITY_HIGH\", \"SEVERITY_MEDIUM\", \"SEVERITY_LOW\".", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary" } }, "agentResourceName": { "description": "The resource name or identifier of the agent. Matches `AgentResource.agent` on the corresponding `MonitoredAgent`, so the format depends on that agent's `AgentResource.agent_type`: * `REASONING_ENGINE`: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` * `CLOUD_RUN_SERVICE`, `GKE_WORKLOAD`, `GCE_INSTANCE`: the resource name of the agent's runtime. * `AGENT_TYPE_OTHER`: a stable identifier for the agent.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1FeatureValue": { "description": "Value for a feature.", "properties": { "int64ArrayValue": { "description": "A list of int64 type feature value.", "$ref": "GoogleCloudAiplatformV1beta1Int64Array" }, "boolArrayValue": { "description": "A list of bool type feature value.", "$ref": "GoogleCloudAiplatformV1beta1BoolArray" }, "doubleArrayValue": { "description": "A list of double type feature value.", "$ref": "GoogleCloudAiplatformV1beta1DoubleArray" }, "boolValue": { "description": "Bool type feature value.", "type": "boolean" }, "metadata": { "description": "Metadata of feature value.", "$ref": "GoogleCloudAiplatformV1beta1FeatureValueMetadata" }, "doubleValue": { "format": "double", "type": "number", "description": "Double type feature value." }, "structValue": { "description": "A struct type feature value.", "$ref": "GoogleCloudAiplatformV1beta1StructValue" }, "bytesValue": { "type": "string", "description": "Bytes feature value.", "format": "byte" }, "stringArrayValue": { "$ref": "GoogleCloudAiplatformV1beta1StringArray", "description": "A list of string type feature value." }, "int64Value": { "type": "string", "format": "int64", "description": "Int64 feature value." }, "stringValue": { "type": "string", "description": "String feature value." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1FeatureValue" }, "GoogleCloudAiplatformV1beta1UndeployModelRequest": { "id": "GoogleCloudAiplatformV1beta1UndeployModelRequest", "type": "object", "properties": { "deployedModelId": { "type": "string", "description": "Required. The ID of the DeployedModel to be undeployed from the Endpoint." }, "trafficSplit": { "additionalProperties": { "type": "integer", "format": "int32" }, "type": "object", "description": "If this field is provided, then the Endpoint's traffic_split will be overwritten with it. If last DeployedModel is being undeployed from the Endpoint, the [Endpoint.traffic_split] will always end up empty when this call returns. A DeployedModel will be successfully undeployed only if it doesn't have any traffic assigned to it when this method executes, or if this field unassigns any traffic to it." } }, "description": "Request message for EndpointService.UndeployModel." }, "GoogleCloudAiplatformV1beta1CopyModelOperationMetadata": { "description": "Details of ModelService.CopyModel operation.", "id": "GoogleCloudAiplatformV1beta1CopyModelOperationMetadata", "type": "object", "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "The common part of the operation metadata." } } }, "GoogleCloudAiplatformV1beta1ImportFeatureValuesRequestFeatureSpec": { "id": "GoogleCloudAiplatformV1beta1ImportFeatureValuesRequestFeatureSpec", "properties": { "id": { "description": "Required. ID of the Feature to import values of. This Feature must exist in the target EntityType, or the request will fail.", "type": "string" }, "sourceField": { "type": "string", "description": "Source column to get the Feature values from. If not set, uses the column with the same name as the Feature ID." } }, "type": "object", "description": "Defines the Feature value(s) to import." }, "GoogleLongrunningListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "properties": { "unreachable": { "type": "array", "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" } }, "operations": { "type": "array", "items": { "$ref": "GoogleLongrunningOperation" }, "description": "A list of operations that matches the specified filter in the request." }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } }, "id": "GoogleLongrunningListOperationsResponse", "type": "object" }, "GoogleCloudAiplatformV1beta1ToolCallValidInstance": { "properties": { "reference": { "description": "Required. Ground truth used to compare against the prediction.", "type": "string" }, "prediction": { "description": "Required. Output of the evaluated model.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1ToolCallValidInstance", "type": "object", "description": "Spec for tool call valid instance." }, "GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentRequest": { "properties": { "inputs": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Chunk" }, "description": "Required. The inputs to the sandbox environment.", "type": "array" } }, "description": "Request message for SandboxEnvironmentExecutionService.Execute.", "type": "object", "id": "GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentRequest" }, "GoogleCloudAiplatformV1beta1ListEvaluationSetsResponse": { "id": "GoogleCloudAiplatformV1beta1ListEvaluationSetsResponse", "type": "object", "description": "Response message for EvaluationManagementService.ListEvaluationSets.", "properties": { "nextPageToken": { "description": "A token to retrieve the next page of results.", "type": "string" }, "evaluationSets": { "items": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationSet" }, "description": "List of EvaluationSets in the requested page.", "type": "array" } } }, "GoogleCloudAiplatformV1beta1VeoHyperParameters": { "properties": { "adapterSize": { "type": "string", "enum": [ "ADAPTER_SIZE_UNSPECIFIED", "ADAPTER_SIZE_EIGHT", "ADAPTER_SIZE_SIXTEEN", "ADAPTER_SIZE_THIRTY_TWO" ], "description": "Optional. The adapter size for LoRA tuning.", "enumDescriptions": [ "Adapter size is unspecified.", "Adapter size 8. This is the default adapter size for Veo LoRA tuning.", "Adapter size 16.", "Adapter size 32." ] }, "veoDataMixtureRatio": { "format": "double", "description": "Optional. The ratio of Google internal dataset to use in the training mixture, in range of `[0, 1)`. If `0.2`, it means 20% of Google internal dataset and 80% of user dataset will be used for training. If not set, the default value is 0.1.", "type": "number" }, "epochCount": { "description": "Optional. Number of complete passes the model makes over the entire training dataset during training.", "type": "string", "format": "int64" }, "tuningTask": { "enumDescriptions": [ "Default value. This value is unused.", "Tuning task for image to video.", "Tuning task for text to video.", "Tuning task for reference to video." ], "enum": [ "TUNING_TASK_UNSPECIFIED", "TUNING_TASK_I2V", "TUNING_TASK_T2V", "TUNING_TASK_R2V" ], "description": "The tuning task for Veo.", "type": "string" }, "learningRateMultiplier": { "format": "double", "type": "number", "description": "Optional. Multiplier for adjusting the default learning rate." }, "tuningSpeed": { "type": "string", "enumDescriptions": [ "The default / unset value. For Veo 3.0 models, this defaults to FAST.", "Regular tuning speed.", "Fast tuning speed." ], "description": "The speed of the tuning job. Only supported for Veo 3.0 models.", "enum": [ "TUNING_SPEED_UNSPECIFIED", "REGULAR", "FAST" ] } }, "type": "object", "description": "Hyperparameters for Veo.", "id": "GoogleCloudAiplatformV1beta1VeoHyperParameters" }, "GenaiVertexV1beta1ArgumentsDelta": { "type": "object", "properties": { "arguments": { "type": "string" } }, "id": "GenaiVertexV1beta1ArgumentsDelta" }, "GoogleCloudAiplatformV1beta1IntermediateExtractedMemory": { "type": "object", "description": "An extracted memory that is the intermediate result before consolidation.", "properties": { "structuredData": { "type": "object", "readOnly": true, "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Output only. Represents the structured value of the extracted memory." }, "fact": { "readOnly": true, "description": "Output only. Represents the fact of the extracted memory.", "type": "string" }, "context": { "readOnly": true, "description": "Output only. Represents the explanation of why the information was extracted from the source content.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1IntermediateExtractedMemory" }, "GoogleCloudAiplatformV1beta1FindNeighborsRequest": { "properties": { "deployedIndexId": { "description": "The ID of the DeployedIndex that will serve the request. This request is sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index has a DeployedIndex.id field. The value of the field below must equal one of the DeployedIndex.id fields of the IndexEndpoint that is being called for this request.", "type": "string" }, "returnFullDatapoint": { "type": "boolean", "description": "If set to true, the full datapoints (including all vector values and restricts) of the nearest neighbors are returned. Note that returning full datapoint will significantly increase the latency and cost of the query." }, "queries": { "type": "array", "description": "The list of queries.", "items": { "$ref": "GoogleCloudAiplatformV1beta1FindNeighborsRequestQuery" } } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1FindNeighborsRequest", "description": "The request message for MatchService.FindNeighbors." }, "GoogleCloudAiplatformV1beta1UpdateOnlineEvaluatorOperationMetadata": { "type": "object", "id": "GoogleCloudAiplatformV1beta1UpdateOnlineEvaluatorOperationMetadata", "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "Generic operation metadata." } }, "description": "Metadata for the UpdateOnlineEvaluator operation." }, "GoogleCloudAiplatformV1beta1RagFileMetadataConfig": { "id": "GoogleCloudAiplatformV1beta1RagFileMetadataConfig", "type": "object", "description": "Metadata config for RagFile.", "properties": { "googleDriveMetadataSource": { "description": "Google Drive location. Supports importing individual files as well as Google Drive folders. If the user provides a directory, the metadata will be read from the files that ends with \"metadata.json\" in the directory.", "$ref": "GoogleCloudAiplatformV1beta1GoogleDriveSource" }, "inlineMetadataSchemaSource": { "description": "Inline metadata schema source. Must be a JSON string.", "type": "string" }, "gcsMetadataSchemaSource": { "$ref": "GoogleCloudAiplatformV1beta1GcsSource", "description": "Google Cloud Storage location. Supports importing individual files as well as entire Google Cloud Storage directories. Sample formats: - `gs://bucket_name/my_directory/object_name/metadata_schema.json` - `gs://bucket_name/my_directory` If the user provides a directory, the metadata schema will be read from the files that ends with \"metadata_schema.json\" in the directory." }, "gcsMetadataSource": { "description": "Google Cloud Storage location. Supports importing individual files as well as entire Google Cloud Storage directories. Sample formats: - `gs://bucket_name/my_directory/object_name/metadata.json` - `gs://bucket_name/my_directory` If the user provides a directory, the metadata will be read from the files that ends with \"metadata.json\" in the directory.", "$ref": "GoogleCloudAiplatformV1beta1GcsSource" }, "inlineMetadataSource": { "type": "string", "description": "Inline metadata source. Must be a JSON string." }, "googleDriveMetadataSchemaSource": { "description": "Google Drive location. Supports importing individual files as well as Google Drive folders. If the user provides a folder, the metadata schema will be read from the files that ends with \"metadata_schema.json\" in the directory.", "$ref": "GoogleCloudAiplatformV1beta1GoogleDriveSource" } } }, "GoogleCloudAiplatformV1beta1ModelGardenSource": { "properties": { "publicModelName": { "type": "string", "description": "Required. The model garden source model resource name." }, "versionId": { "type": "string", "description": "Optional. The model garden source model version ID." }, "skipHfModelCache": { "type": "boolean", "description": "Optional. Whether to avoid pulling the model from the HF cache." } }, "description": "Contains information about the source of the models generated from Model Garden.", "type": "object", "id": "GoogleCloudAiplatformV1beta1ModelGardenSource" }, "GenaiVertexV1beta1EnvironmentConfigEnvironmentNetworkEgressAllowlist": { "description": "Network egress configuration for the environment.", "type": "object", "properties": { "allowlist": { "description": "List of allowed domains and their configurations.", "type": "array", "items": { "$ref": "GenaiVertexV1beta1EnvironmentConfigEgressRule" } } }, "id": "GenaiVertexV1beta1EnvironmentConfigEnvironmentNetworkEgressAllowlist" }, "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateResourceRequirements": { "properties": { "requests": { "description": "Optional. The requested amounts of compute resources. Keys are resource names (e.g., \"cpu\", \"memory\"). Values are quantities (e.g., \"250m\", \"512Mi\").", "type": "object", "additionalProperties": { "type": "string" } }, "limits": { "type": "object", "description": "Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., \"cpu\", \"memory\"). Values are quantities (e.g., \"500m\", \"1Gi\").", "additionalProperties": { "type": "string" } } }, "description": "Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template.", "type": "object", "id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateResourceRequirements" }, "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSource": { "properties": { "events": { "items": { "$ref": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSourceEvent" }, "type": "array", "description": "Optional. Represents the input conversation events for the example." } }, "id": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSource", "description": "A conversation source for the example. This is similar to `DirectContentsSource`.", "type": "object" }, "GoogleCloudAiplatformV1beta1TrajectoryAnyOrderMatchSpec": { "properties": {}, "id": "GoogleCloudAiplatformV1beta1TrajectoryAnyOrderMatchSpec", "type": "object", "description": "Spec for TrajectoryAnyOrderMatch metric - returns 1 if all tool calls in the reference trajectory appear in the predicted trajectory in any order, else 0." }, "GoogleCloudAiplatformV1beta1FindNeighborsRequestQuery": { "description": "A query to find a number of the nearest neighbors (most similar vectors) of a vector.", "id": "GoogleCloudAiplatformV1beta1FindNeighborsRequestQuery", "properties": { "rrf": { "description": "Optional. Represents RRF algorithm that combines search results.", "$ref": "GoogleCloudAiplatformV1beta1FindNeighborsRequestQueryRRF" }, "approximateNeighborCount": { "description": "The number of neighbors to find via approximate search before exact reordering is performed. If not set, the default value from scam config is used; if set, this value must be \u003e 0.", "format": "int32", "type": "integer" }, "perCrowdingAttributeNeighborCount": { "type": "integer", "description": "Crowding is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than some value k' of the k neighbors returned have the same value of crowding_attribute. It's used for improving result diversity. This field is the maximum number of matches with the same crowding tag.", "format": "int32" }, "neighborCount": { "type": "integer", "format": "int32", "description": "The number of nearest neighbors to be retrieved from database for each query. If not set, will use the default from the service configuration (https://cloud.google.com/vertex-ai/docs/matching-engine/configuring-indexes#nearest-neighbor-search-config)." }, "datapoint": { "description": "Required. The datapoint/vector whose nearest neighbors should be searched for.", "$ref": "GoogleCloudAiplatformV1beta1IndexDatapoint" }, "fractionLeafNodesToSearchOverride": { "type": "number", "description": "The fraction of the number of leaves to search, set at query time allows user to tune search performance. This value increase result in both search accuracy and latency increase. The value should be between 0.0 and 1.0. If not set or set to 0.0, query uses the default value specified in NearestNeighborSearchConfig.TreeAHConfig.fraction_leaf_nodes_to_search.", "format": "double" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1SafetyRating": { "description": "A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level.", "properties": { "blocked": { "readOnly": true, "description": "Output only. Indicates whether the content was blocked because of this rating.", "type": "boolean" }, "severityScore": { "readOnly": true, "format": "float", "type": "number", "description": "Output only. The severity score of harm for this category." }, "overwrittenThreshold": { "enum": [ "HARM_BLOCK_THRESHOLD_UNSPECIFIED", "BLOCK_LOW_AND_ABOVE", "BLOCK_MEDIUM_AND_ABOVE", "BLOCK_ONLY_HIGH", "BLOCK_NONE", "OFF" ], "readOnly": true, "enumDescriptions": [ "The harm block threshold is unspecified.", "Block content with a low harm probability or higher.", "Block content with a medium harm probability or higher.", "Block content with a high harm probability.", "Do not block any content, regardless of its harm probability.", "Turn off the safety filter entirely." ], "type": "string", "description": "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." }, "probabilityScore": { "readOnly": true, "format": "float", "type": "number", "description": "Output only. The probability score of harm for this category." }, "category": { "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "Content that promotes violence or incites hatred against individuals or groups based on certain attributes.", "Content that promotes, facilitates, or enables dangerous activities.", "Abusive, threatening, or content intended to bully, torment, or ridicule.", "Content that contains sexually explicit material.", "Deprecated: Election filter is not longer supported. The harm category is civic integrity.", "Images that contain hate speech.", "Images that contain dangerous content.", "Images that contain harassment.", "Images that contain sexually explicit content.", "Prompts designed to bypass safety filters." ], "enumDeprecated": [ false, false, false, false, false, true, false, false, false, false, false ], "enum": [ "HARM_CATEGORY_UNSPECIFIED", "HARM_CATEGORY_HATE_SPEECH", "HARM_CATEGORY_DANGEROUS_CONTENT", "HARM_CATEGORY_HARASSMENT", "HARM_CATEGORY_SEXUALLY_EXPLICIT", "HARM_CATEGORY_CIVIC_INTEGRITY", "HARM_CATEGORY_IMAGE_HATE", "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT", "HARM_CATEGORY_IMAGE_HARASSMENT", "HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT", "HARM_CATEGORY_JAILBREAK" ], "description": "Output only. The harm category of this rating.", "readOnly": true }, "severity": { "readOnly": true, "type": "string", "description": "Output only. The severity of harm for this category.", "enum": [ "HARM_SEVERITY_UNSPECIFIED", "HARM_SEVERITY_NEGLIGIBLE", "HARM_SEVERITY_LOW", "HARM_SEVERITY_MEDIUM", "HARM_SEVERITY_HIGH" ], "enumDescriptions": [ "The harm severity is unspecified.", "The harm severity is negligible.", "The harm severity is low.", "The harm severity is medium.", "The harm severity is high." ] }, "probability": { "type": "string", "readOnly": true, "enum": [ "HARM_PROBABILITY_UNSPECIFIED", "NEGLIGIBLE", "LOW", "MEDIUM", "HIGH" ], "enumDescriptions": [ "The harm probability is unspecified.", "The harm probability is negligible.", "The harm probability is low.", "The harm probability is medium.", "The harm probability is high." ], "description": "Output only. The probability of harm for this category." } }, "id": "GoogleCloudAiplatformV1beta1SafetyRating", "type": "object" }, "CloudAiLargeModelsVisionGenerateVideoExperimentsConditioningFrame": { "properties": { "image": { "$ref": "CloudAiLargeModelsVisionGenerateVideoRequestImage", "description": "The image data for this conditioning frame." }, "frameNum": { "format": "int32", "type": "integer", "description": "The index of the frame, starts with zero and must be a multiple of 8." } }, "type": "object", "id": "CloudAiLargeModelsVisionGenerateVideoExperimentsConditioningFrame" }, "GenaiVertexV1beta1StepStop": { "type": "object", "properties": { "stepUsage": { "$ref": "GenaiVertexV1beta1InteractionUsage", "description": "Model usage stats for this specific step." }, "index": { "type": "integer", "format": "int32" }, "usage": { "$ref": "GenaiVertexV1beta1InteractionUsage", "description": "Cumulative model usage stats from the start of the session." } }, "id": "GenaiVertexV1beta1StepStop" }, "GoogleCloudAiplatformV1beta1ToolGoogleSearchImageSearch": { "id": "GoogleCloudAiplatformV1beta1ToolGoogleSearchImageSearch", "type": "object", "description": "Image search for grounding and related configurations.", "properties": {} }, "GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricBasedMetricSpecRepeatedRubrics": { "type": "object", "id": "GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricBasedMetricSpecRepeatedRubrics", "properties": { "rubrics": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Rubric" }, "type": "array", "description": "The list of rubrics." } }, "description": "Defines a list of rubrics, used when providing rubrics inline." }, "GoogleCloudAiplatformV1beta1TensorboardRun": { "type": "object", "id": "GoogleCloudAiplatformV1beta1TensorboardRun", "description": "TensorboardRun maps to a specific execution of a training job with a given set of hyperparameter values, model definition, dataset, etc", "properties": { "updateTime": { "description": "Output only. Timestamp when this TensorboardRun was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "description": { "type": "string", "description": "Description of this TensorboardRun." }, "createTime": { "type": "string", "description": "Output only. Timestamp when this TensorboardRun was created.", "readOnly": true, "format": "google-datetime" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The labels with user-defined metadata to organize your TensorboardRuns. This field will be used to filter and visualize Runs in the Tensorboard UI. For example, a Vertex AI training job can set a label aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created within that job. An end user can set a label experiment_id=xxxxx for all the runs produced in a Jupyter notebook. These runs can be grouped by a label value and visualized together in the Tensorboard UI. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one TensorboardRun (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable." }, "etag": { "description": "Used to perform a consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "type": "string" }, "displayName": { "type": "string", "description": "Required. User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment." }, "name": { "readOnly": true, "description": "Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", "type": "string" } } }, "GoogleCloudAiplatformV1beta1ModelMonitoringSchema": { "properties": { "groundTruthFields": { "type": "array", "description": "Target /ground truth names of the model.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringSchemaFieldSchema" } }, "predictionFields": { "items": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringSchemaFieldSchema" }, "type": "array", "description": "Prediction output names of the model. The requirements are the same as the feature_fields. For AutoML Tables, the prediction output name presented in schema will be: `predicted_{target_column}`, the `target_column` is the one you specified when you train the model. For Prediction output drift analysis: * AutoML Classification, the distribution of the argmax label will be analyzed. * AutoML Regression, the distribution of the value will be analyzed." }, "featureFields": { "description": "Feature names of the model. Vertex AI will try to match the features from your dataset as follows: * For 'csv' files, the header names are required, and we will extract the corresponding feature values when the header names align with the feature names. * For 'jsonl' files, we will extract the corresponding feature values if the key names match the feature names. Note: Nested features are not supported, so please ensure your features are flattened. Ensure the feature values are scalar or an array of scalars. * For 'bigquery' dataset, we will extract the corresponding feature values if the column names match the feature names. Note: The column type can be a scalar or an array of scalars. STRUCT or JSON types are not supported. You may use SQL queries to select or aggregate the relevant features from your original table. However, ensure that the 'schema' of the query results meets our requirements. * For the Vertex AI Endpoint Request Response Logging table or Vertex AI Batch Prediction Job results. If the instance_type is an array, ensure that the sequence in feature_fields matches the order of features in the prediction instance. We will match the feature with the array in the order specified in [feature_fields].", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringSchemaFieldSchema" }, "type": "array" } }, "id": "GoogleCloudAiplatformV1beta1ModelMonitoringSchema", "description": "The Model Monitoring Schema definition.", "type": "object" }, "GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigSimilaritySearchConfig": { "description": "Configuration for how to perform similarity search on memories.", "properties": { "embeddingModel": { "type": "string", "description": "Required. The model used to generate embeddings to lookup similar memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigSimilaritySearchConfig" }, "GoogleCloudAiplatformV1beta1QuestionAnsweringCorrectnessInput": { "description": "Input for question answering correctness metric.", "properties": { "metricSpec": { "$ref": "GoogleCloudAiplatformV1beta1QuestionAnsweringCorrectnessSpec", "description": "Required. Spec for question answering correctness score metric." }, "instance": { "description": "Required. Question answering correctness instance.", "$ref": "GoogleCloudAiplatformV1beta1QuestionAnsweringCorrectnessInstance" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1QuestionAnsweringCorrectnessInput" }, "GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigPersistentResourceRuntimeDetail": { "properties": { "persistentResourceName": { "type": "string", "description": "Persistent resource name. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`" }, "taskResourceUnavailableTimeoutBehavior": { "type": "string", "enumDescriptions": [ "Unspecified. Behavior is same as `FAIL`.", "Fail the task if the timeout is reached.", "Fall back to on-demand execution if the timeout is reached." ], "enum": [ "TASK_RESOURCE_UNAVAILABLE_TIMEOUT_BEHAVIOR_UNSPECIFIED", "FAIL", "FALL_BACK_TO_ON_DEMAND" ], "description": "Specifies the behavior to take if the timeout is reached." }, "taskResourceUnavailableWaitTimeMs": { "type": "string", "format": "int64", "description": "The max time a pipeline task waits for the required CPU, memory, or accelerator resource to become available from the specified persistent resource. Default wait time is 0." } }, "id": "GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigPersistentResourceRuntimeDetail", "type": "object", "description": "Persistent resource based runtime detail. For more information about persistent resource, refer to https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesMetadata": { "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesMetadata", "properties": { "trainCostMilliNodeHours": { "type": "string", "description": "Output only. The actual training cost of the model, expressed in milli node hours, i.e. 1,000 value in this field means 1 node hour. Guaranteed to not exceed the train budget.", "format": "int64" }, "evaluatedDataItemsBigqueryUri": { "description": "BigQuery destination uri for exported evaluated examples.", "type": "string" } }, "type": "object", "description": "Model metadata specific to AutoML Tables." }, "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecInlineSource": { "description": "Specifies source code provided as a byte stream.", "properties": { "sourceArchive": { "type": "string", "description": "Required. Input only. The application source code archive. It must be a compressed tarball (.tar.gz) file.", "format": "byte" } }, "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecInlineSource", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaPredictPredictionImageObjectDetectionPredictionResult": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaPredictPredictionImageObjectDetectionPredictionResult", "properties": { "confidences": { "type": "array", "description": "The Model's confidences in correctness of the predicted IDs, higher value means higher confidence. Order matches the Ids.", "items": { "type": "number", "format": "float" } }, "bboxes": { "items": { "type": "array", "items": { "type": "any" } }, "type": "array", "description": "Bounding boxes, i.e. the rectangles over the image, that pinpoint the found AnnotationSpecs. Given in order that matches the IDs. Each bounding box is an array of 4 numbers `xMin`, `xMax`, `yMin`, and `yMax`, which represent the extremal coordinates of the box. They are relative to the image size, and the point 0,0 is in the top left of the image." }, "displayNames": { "items": { "type": "string" }, "description": "The display names of the AnnotationSpecs that had been identified, order matches the IDs.", "type": "array" }, "ids": { "type": "array", "description": "The resource IDs of the AnnotationSpecs that had been identified, ordered by the confidence score descendingly.", "items": { "type": "string", "format": "int64" } } }, "description": "Prediction output format for Image Object Detection." }, "GoogleCloudAiplatformV1beta1SlackSourceSlackChannels": { "properties": { "apiKeyConfig": { "description": "Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Slack channel access token that has access to the slack channel IDs. See: https://api.slack.com/tutorials/tracks/getting-a-token.", "$ref": "GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig" }, "channels": { "type": "array", "description": "Required. The Slack channel IDs.", "items": { "$ref": "GoogleCloudAiplatformV1beta1SlackSourceSlackChannelsSlackChannel" } } }, "type": "object", "description": "SlackChannels contains the Slack channels and corresponding access token.", "id": "GoogleCloudAiplatformV1beta1SlackSourceSlackChannels" }, "GoogleCloudAiplatformV1beta1AudioResponseFormat": { "description": "Configuration for audio-specific output formatting.", "properties": { "sampleRate": { "format": "int32", "description": "Optional. Sample rate for the generated audio in Hertz.", "type": "integer" }, "mimeType": { "enum": [ "MIME_TYPE_UNSPECIFIED", "AUDIO_MP3", "AUDIO_OGG_OPUS", "AUDIO_L16", "AUDIO_WAV", "AUDIO_ALAW", "AUDIO_MULAW" ], "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "MP3 audio format.", "OGG Opus audio format.", "Raw PCM (L16) audio format.", "WAV audio format.", "A-law audio format.", "Mu-law audio format." ], "description": "Optional. The MIME type of the audio output." }, "delivery": { "type": "string", "description": "Optional. Delivery mode for the generated content.", "enumDescriptions": [ "Default value. This value is unused.", "Generated bytes are returned inline in the response.", "Generated content is stored and a URI is returned." ], "enum": [ "DELIVERY_UNSPECIFIED", "INLINE", "URI" ] }, "bitRate": { "description": "Optional. Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).", "type": "integer", "format": "int32" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1AudioResponseFormat" }, "GoogleLongrunningOperation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "properties": { "error": { "$ref": "GoogleRpcStatus", "description": "The error result of the operation in case of failure or cancellation." }, "response": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "description": "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`." }, "metadata": { "description": "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.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "name": { "description": "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}`.", "type": "string" }, "done": { "description": "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.", "type": "boolean" } }, "id": "GoogleLongrunningOperation" }, "GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesRequest": { "description": "Request message for FeatureOnlineStoreService.StreamingFetchFeatureValues. For the entities requested, all features under the requested feature view will be returned.", "type": "object", "id": "GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesRequest", "properties": { "dataFormat": { "type": "string", "enum": [ "FEATURE_VIEW_DATA_FORMAT_UNSPECIFIED", "KEY_VALUE", "PROTO_STRUCT" ], "description": "Specify response data format. If not set, KeyValue format will be used.", "enumDescriptions": [ "Not set. Will be treated as the KeyValue format.", "Return response data in key-value format.", "Return response data in proto Struct format." ] }, "dataKeys": { "items": { "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDataKey" }, "type": "array" } } }, "GoogleCloudAiplatformV1beta1SchemaPromptSpecTranslationSentenceFileInput": { "properties": { "fileInputSource": { "description": "Inlined file source.", "$ref": "GoogleCloudAiplatformV1beta1SchemaPromptSpecTranslationFileInputSource" }, "gcsInputSource": { "$ref": "GoogleCloudAiplatformV1beta1SchemaPromptSpecTranslationGcsInputSource", "description": "Cloud Storage file source." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaPromptSpecTranslationSentenceFileInput" }, "GoogleCloudAiplatformV1beta1GeminiPreferenceExampleCompletion": { "id": "GoogleCloudAiplatformV1beta1GeminiPreferenceExampleCompletion", "type": "object", "properties": { "score": { "format": "float", "description": "The score for the given completion.", "type": "number" }, "completion": { "description": "Single turn completion for the given prompt.", "$ref": "GoogleCloudAiplatformV1beta1Content" } }, "description": "Completion and its preference score." }, "GoogleCloudAiplatformV1beta1ExtensionPrivateServiceConnectConfig": { "properties": { "serviceDirectory": { "type": "string", "description": "Required. The Service Directory resource name in which the service endpoints associated to the extension are registered. Format: `projects/{project_id}/locations/{location_id}/namespaces/{namespace_id}/services/{service_id}` - The Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) should be granted `servicedirectory.viewer` and `servicedirectory.pscAuthorizedService` roles on the resource." } }, "description": "PrivateExtensionConfig configuration for the extension.", "type": "object", "id": "GoogleCloudAiplatformV1beta1ExtensionPrivateServiceConnectConfig" }, "GoogleCloudAiplatformV1beta1A2ATaskRecordEvent": { "properties": { "createTime": { "readOnly": true, "type": "string", "description": "Output only. The time at which the event was created.", "format": "google-datetime" }, "eventData": { "description": "Required. The data describing the change carried by this event.", "$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordEventData" }, "metadata": { "description": "Optional. Additional context or parameters related to the event. Extensions can be used to strongly type metadata values for specific use cases.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "generation": { "format": "int64", "description": "Output only. The generation number of the task after this event is applied.", "type": "string", "readOnly": true } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1A2ATaskRecordEvent", "description": "An event that records a single change applied to a task's state." }, "GoogleCloudAiplatformV1beta1A2aTaskMetadataChange": { "properties": { "metadata": { "description": "Required. The complete task metadata after the change.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "updateMask": { "type": "string", "format": "google-fieldmask", "description": "Optional. A field mask indicating which metadata paths changed. If unset, all fields are updated." } }, "id": "GoogleCloudAiplatformV1beta1A2aTaskMetadataChange", "description": "An event payload describing a change to the task-level metadata.", "type": "object" }, "GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest": { "type": "object", "properties": { "vmToken": { "type": "string", "description": "Required. The VM identity token (a JWT) for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity" } }, "description": "Request message for NotebookInternalService.GenerateAccessToken.", "id": "GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest" }, "GoogleCloudAiplatformV1beta1VertexMultimodalDatasetDestination": { "type": "object", "description": "The details for a Vertex Multimodal Dataset output.", "properties": { "bigqueryDestination": { "$ref": "GoogleCloudAiplatformV1beta1BigQueryDestination", "description": "Optional. The destination of the underlying BigQuery table that will be created for the output Multimodal Dataset. If not specified, the BigQuery table will be created in a default BigQuery dataset." }, "displayName": { "description": "Optional. Display name of the output dataset.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1VertexMultimodalDatasetDestination" }, "GoogleCloudAiplatformV1beta1ModelExplanation": { "id": "GoogleCloudAiplatformV1beta1ModelExplanation", "description": "Aggregated explanation metrics for a Model over a set of instances.", "type": "object", "properties": { "meanAttributions": { "type": "array", "readOnly": true, "description": "Output only. Aggregated attributions explaining the Model's prediction outputs over the set of instances. The attributions are grouped by outputs. For Models that predict only one output, such as regression Models that predict only one score, there is only one attibution that explains the predicted output. For Models that predict multiple outputs, such as multiclass Models that predict multiple classes, each element explains one specific item. Attribution.output_index can be used to identify which output this attribution is explaining. The baselineOutputValue, instanceOutputValue and featureAttributions fields are averaged over the test data. NOTE: Currently AutoML tabular classification Models produce only one attribution, which averages attributions over all the classes it predicts. Attribution.approximation_error is not populated.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Attribution" } } } }, "GoogleCloudAiplatformV1beta1A2aTaskArtifact": { "description": "Represents a single artifact produced by a task.", "properties": { "displayName": { "type": "string", "description": "Optional. The human-readable name of the artifact." }, "artifactId": { "description": "Required. The unique identifier of the artifact within the task.", "type": "string" }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "Optional. Additional context or parameters related to the artifact. Extensions can be used to strongly type metadata values for specific use cases." }, "parts": { "description": "Required. The content parts that make up the artifact.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1A2aPart" } }, "extensions": { "items": { "type": "string" }, "description": "Optional. A2A protocol extensions associated with the artifact.", "type": "array" }, "description": { "type": "string", "description": "Optional. A human-readable description of the artifact." } }, "id": "GoogleCloudAiplatformV1beta1A2aTaskArtifact", "type": "object" }, "GoogleCloudAiplatformV1beta1Context": { "type": "object", "id": "GoogleCloudAiplatformV1beta1Context", "description": "Instance of a general context.", "properties": { "labels": { "description": "The labels with user-defined metadata to organize your Contexts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Context (System labels are excluded).", "type": "object", "additionalProperties": { "type": "string" } }, "metadata": { "description": "Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "displayName": { "description": "User provided display name of the Context. May be up to 128 Unicode characters.", "type": "string" }, "createTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp when this Context was created.", "type": "string" }, "name": { "description": "Immutable. The resource name of the Context.", "type": "string" }, "description": { "type": "string", "description": "Description of the Context" }, "parentContexts": { "readOnly": true, "items": { "type": "string" }, "type": "array", "description": "Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts." }, "schemaVersion": { "description": "The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.", "type": "string" }, "schemaTitle": { "description": "The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.", "type": "string" }, "etag": { "type": "string", "description": "An eTag used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens." }, "updateTime": { "readOnly": true, "description": "Output only. Timestamp when this Context was last updated.", "format": "google-datetime", "type": "string" } } }, "GoogleCloudAiplatformV1beta1SavedQuery": { "type": "object", "properties": { "problemType": { "type": "string", "description": "Required. Problem type of the SavedQuery. Allowed values: * IMAGE_CLASSIFICATION_SINGLE_LABEL * IMAGE_CLASSIFICATION_MULTI_LABEL * IMAGE_BOUNDING_POLY * IMAGE_BOUNDING_BOX * TEXT_CLASSIFICATION_SINGLE_LABEL * TEXT_CLASSIFICATION_MULTI_LABEL * TEXT_EXTRACTION * TEXT_SENTIMENT * VIDEO_CLASSIFICATION * VIDEO_OBJECT_TRACKING" }, "name": { "readOnly": true, "type": "string", "description": "Output only. Resource name of the SavedQuery." }, "supportAutomlTraining": { "description": "Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training.", "readOnly": true, "type": "boolean" }, "updateTime": { "description": "Output only. Timestamp when SavedQuery was last updated.", "type": "string", "format": "google-datetime", "readOnly": true }, "etag": { "description": "Used to perform a consistent read-modify-write update. If not set, a blind \"overwrite\" update happens.", "type": "string" }, "annotationSpecCount": { "format": "int32", "type": "integer", "description": "Output only. Number of AnnotationSpecs in the context of the SavedQuery.", "readOnly": true }, "displayName": { "type": "string", "description": "Required. The user-defined name of the SavedQuery. The name can be up to 128 characters long and can consist of any UTF-8 characters." }, "annotationFilter": { "description": "Output only. Filters on the Annotations in the dataset.", "readOnly": true, "type": "string" }, "metadata": { "type": "any", "description": "Some additional information about the SavedQuery." }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when this SavedQuery was created." } }, "id": "GoogleCloudAiplatformV1beta1SavedQuery", "description": "A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters." }, "GoogleCloudAiplatformV1beta1RestoreDatasetVersionOperationMetadata": { "id": "GoogleCloudAiplatformV1beta1RestoreDatasetVersionOperationMetadata", "type": "object", "properties": { "genericMetadata": { "description": "The common part of the operation metadata.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "description": "Runtime operation information for DatasetService.RestoreDatasetVersion." }, "GoogleCloudAiplatformV1beta1ExplanationMetadata": { "id": "GoogleCloudAiplatformV1beta1ExplanationMetadata", "properties": { "featureAttributionsSchemaUri": { "description": "Points to a YAML file stored on Google Cloud Storage describing the format of the feature attributions. 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 tabular Models always have this field populated by Vertex AI. Note: The URI given on output may be 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.", "type": "string" }, "inputs": { "description": "Required. Map from feature names to feature input metadata. Keys are the name of the features. Values are the specification of the feature. An empty InputMetadata is valid. It describes a text feature which has the name specified as the key in ExplanationMetadata.inputs. The baseline of the empty feature is chosen by Vertex AI. For Vertex AI-provided Tensorflow images, the key can be any friendly name of the feature. Once specified, featureAttributions are keyed by this key (if not grouped with another feature). For custom images, the key must match with the key in instance.", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1ExplanationMetadataInputMetadata" }, "type": "object" }, "outputs": { "type": "object", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1ExplanationMetadataOutputMetadata" }, "description": "Required. Map from output names to output metadata. For Vertex AI-provided Tensorflow images, keys can be any user defined string that consists of any UTF-8 characters. For custom images, keys are the name of the output field in the prediction to be explained. Currently only one key is allowed." }, "latentSpaceSource": { "description": "Name of the source to generate embeddings for example based explanations.", "type": "string" } }, "type": "object", "description": "Metadata describing the Model's input and output for explanation." }, "GoogleCloudAiplatformV1beta1DeployRequestCustomModel": { "type": "object", "description": "The custom model to deploy from model weights in a Google Cloud Storage URI or Model Registry model.", "id": "GoogleCloudAiplatformV1beta1DeployRequestCustomModel", "properties": { "gcsUri": { "type": "string", "description": "Immutable. The Google Cloud Storage URI of the custom model, storing weights and config files (which can be used to infer the base model)." }, "modelId": { "type": "string", "deprecated": true, "description": "Optional. Deprecated. Use ModelConfig.model_user_id instead." } } }, "GoogleCloudAiplatformV1beta1NotebookRuntimeTemplateRef": { "properties": { "notebookRuntimeTemplate": { "description": "Immutable. A resource name of the NotebookRuntimeTemplate.", "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1NotebookRuntimeTemplateRef", "description": "Points to a NotebookRuntimeTemplateRef." }, "GoogleCloudAiplatformV1beta1SchemaPredictPredictionTftFeatureImportance": { "id": "GoogleCloudAiplatformV1beta1SchemaPredictPredictionTftFeatureImportance", "type": "object", "properties": { "attributeWeights": { "items": { "type": "number", "format": "float" }, "type": "array" }, "horizonWeights": { "items": { "format": "float", "type": "number" }, "type": "array" }, "contextWeights": { "description": "TFT feature importance values. Each pair for {context/horizon/attribute} should have the same shape since the weight corresponds to the column names.", "type": "array", "items": { "format": "float", "type": "number" } }, "attributeColumns": { "type": "array", "items": { "type": "string" } }, "horizonColumns": { "type": "array", "items": { "type": "string" } }, "contextColumns": { "type": "array", "items": { "type": "string" } } } }, "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode": { "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode", "description": "The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference.", "properties": { "modelRoutingPreference": { "enumDescriptions": [ "Unspecified model routing preference.", "The model will be selected to prioritize the quality of the response.", "The model will be selected to balance quality and cost.", "The model will be selected to prioritize the cost of the request." ], "enum": [ "UNKNOWN", "PRIORITIZE_QUALITY", "BALANCED", "PRIORITIZE_COST" ], "description": "The model routing preference.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ListNotebookRuntimesResponse": { "type": "object", "properties": { "nextPageToken": { "description": "A token to retrieve next page of results. Pass to ListNotebookRuntimesRequest.page_token to obtain that page.", "type": "string" }, "notebookRuntimes": { "description": "List of NotebookRuntimes in the requested page.", "items": { "$ref": "GoogleCloudAiplatformV1beta1NotebookRuntime" }, "type": "array" } }, "id": "GoogleCloudAiplatformV1beta1ListNotebookRuntimesResponse", "description": "Response message for NotebookService.ListNotebookRuntimes." }, "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef": { "properties": { "id": { "type": "string", "description": "ID of the AnnotationSpec." }, "displayName": { "type": "string", "description": "Display name of the AnnotationSpec." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsConfusionMatrixAnnotationSpecRef" }, "GoogleCloudAiplatformV1beta1NearestNeighborQueryParameters": { "properties": { "leafNodesSearchFraction": { "type": "number", "description": "Optional. The fraction of the number of leaves to search, set at query time allows user to tune search performance. This value increase result in both search accuracy and latency increase. The value should be between 0.0 and 1.0.", "format": "double" }, "approximateNeighborCandidates": { "description": "Optional. The number of neighbors to find via approximate search before exact reordering is performed; if set, this value must be \u003e neighbor_count.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudAiplatformV1beta1NearestNeighborQueryParameters", "description": "Parameters that can be overrided in each query to tune query latency and recall.", "type": "object" }, "GoogleCloudAiplatformV1beta1StudySpecConvexAutomatedStoppingSpec": { "description": "Configuration for ConvexAutomatedStoppingSpec. When there are enough completed trials (configured by min_measurement_count), for pending trials with enough measurements and steps, the policy first computes an overestimate of the objective value at max_num_steps according to the slope of the incomplete objective value curve. No prediction can be made if the curve is completely flat. If the overestimation is worse than the best objective value of the completed trials, this pending trial will be early-stopped, but a last measurement will be added to the pending trial with max_num_steps and predicted objective value from the autoregression model.", "id": "GoogleCloudAiplatformV1beta1StudySpecConvexAutomatedStoppingSpec", "properties": { "useElapsedDuration": { "description": "This bool determines whether or not the rule is applied based on elapsed_secs or steps. If use_elapsed_duration==false, the early stopping decision is made according to the predicted objective values according to the target steps. If use_elapsed_duration==true, elapsed_secs is used instead of steps. Also, in this case, the parameters max_num_steps and min_num_steps are overloaded to contain max_elapsed_seconds and min_elapsed_seconds.", "type": "boolean" }, "updateAllStoppedTrials": { "description": "ConvexAutomatedStoppingSpec by default only updates the trials that needs to be early stopped using a newly trained auto-regressive model. When this flag is set to True, all stopped trials from the beginning are potentially updated in terms of their `final_measurement`. Also, note that the training logic of autoregressive models is different in this case. Enabling this option has shown better results and this may be the default option in the future.", "type": "boolean" }, "minStepCount": { "description": "Minimum number of steps for a trial to complete. Trials which do not have a measurement with step_count \u003e min_step_count won't be considered for early stopping. It's ok to set it to 0, and a trial can be early stopped at any stage. By default, min_step_count is set to be one-tenth of the max_step_count. When use_elapsed_duration is true, this field is set to the minimum elapsed seconds.", "format": "int64", "type": "string" }, "learningRateParameterName": { "description": "The hyper-parameter name used in the tuning job that stands for learning rate. Leave it blank if learning rate is not in a parameter in tuning. The learning_rate is used to estimate the objective value of the ongoing trial.", "type": "string" }, "maxStepCount": { "type": "string", "description": "Steps used in predicting the final objective for early stopped trials. In general, it's set to be the same as the defined steps in training / tuning. If not defined, it will learn it from the completed trials. When use_steps is false, this field is set to the maximum elapsed seconds.", "format": "int64" }, "minMeasurementCount": { "type": "string", "description": "The minimal number of measurements in a Trial. Early-stopping checks will not trigger if less than min_measurement_count+1 completed trials or pending trials with less than min_measurement_count measurements. If not defined, the default value is 5.", "format": "int64" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse": { "id": "GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse", "type": "object", "description": "Response message for NotebookInternalService.GenerateToken.", "properties": { "tokenType": { "description": "Type of the returned access token (e.g. \"Bearer\"). It specifies how the token must be used. Bearer tokens may be used by any entity without proof of identity.", "type": "string" }, "expiresIn": { "type": "integer", "description": "The time in seconds when the access token expires. Typically that's 3600.", "format": "int32" }, "accessToken": { "description": "Short-lived access token string which may be used to access Google APIs.", "type": "string" }, "scope": { "description": "Space-separated list of scopes contained in the returned token. https://cloud.google.com/docs/authentication/token-types#access-contents", "type": "string" } } }, "GoogleCloudAiplatformV1beta1ListAnnotationsResponse": { "description": "Response message for DatasetService.ListAnnotations.", "properties": { "nextPageToken": { "type": "string", "description": "The standard List next-page token." }, "annotations": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Annotation" }, "type": "array", "description": "A list of Annotations that matches the specified filter in the request." } }, "id": "GoogleCloudAiplatformV1beta1ListAnnotationsResponse", "type": "object" }, "GoogleIamV1GetIamPolicyRequest": { "properties": { "options": { "$ref": "GoogleIamV1GetPolicyOptions", "description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`." } }, "description": "Request message for `GetIamPolicy` method.", "id": "GoogleIamV1GetIamPolicyRequest", "type": "object" }, "GenaiVertexV1beta1CodeExecutionResultStep": { "id": "GenaiVertexV1beta1CodeExecutionResultStep", "type": "object", "description": "Code execution result step.", "properties": { "result": { "type": "string", "description": "Required. The output of the code execution." }, "isError": { "type": "boolean", "description": "Whether the code execution resulted in an error." } } }, "GoogleCloudAiplatformV1beta1RecommendSpecResponseMachineAndModelContainerSpec": { "description": "A machine and model container spec.", "properties": { "machineSpec": { "$ref": "GoogleCloudAiplatformV1beta1MachineSpec", "readOnly": true, "description": "Output only. The machine spec." }, "containerSpec": { "description": "Output only. The model container spec.", "$ref": "GoogleCloudAiplatformV1beta1ModelContainerSpec", "readOnly": true } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1RecommendSpecResponseMachineAndModelContainerSpec" }, "GenaiVertexV1beta1UrlCitation": { "properties": { "title": { "description": "The title of the URL.", "type": "string" }, "url": { "type": "string", "description": "The URL." } }, "description": "A URL citation annotation.", "id": "GenaiVertexV1beta1UrlCitation", "type": "object" }, "GoogleCloudAiplatformV1beta1AskContextsRequest": { "description": "Agentic Retrieval Ask API for RAG. Request message for VertexRagService.AskContexts.", "id": "GoogleCloudAiplatformV1beta1AskContextsRequest", "type": "object", "properties": { "tools": { "type": "array", "description": "Optional. The tools to use for AskContexts.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Tool" } }, "query": { "$ref": "GoogleCloudAiplatformV1beta1RagQuery", "description": "Required. Single RAG retrieve query." } } }, "GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpec": { "properties": { "shieldedInstanceConfig": { "description": "Optional. Shielded VM configuration (for example, Secure Boot) for the execution VM.", "$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig" }, "machineSpec": { "description": "The specification of a single machine for the execution job.", "$ref": "GoogleCloudAiplatformV1beta1MachineSpec" }, "networkSpec": { "description": "The network configuration to use for the execution job.", "$ref": "GoogleCloudAiplatformV1beta1NetworkSpec" }, "persistentDiskSpec": { "description": "The specification of a persistent disk to attach for the execution job.", "$ref": "GoogleCloudAiplatformV1beta1PersistentDiskSpec" } }, "type": "object", "description": "Compute configuration to use for an execution job.", "id": "GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpec" }, "GoogleCloudAiplatformV1beta1SpecialistPool": { "description": "SpecialistPool represents customers' own workforce to work on their data labeling jobs. It includes a group of specialist managers and workers. Managers are responsible for managing the workers in this pool as well as customers' data labeling jobs associated with this pool. Customers create specialist pool as well as start data labeling jobs on Cloud, managers and workers handle the jobs using CrowdCompute console.", "properties": { "specialistWorkerEmails": { "type": "array", "items": { "type": "string" }, "description": "The email addresses of workers in the SpecialistPool." }, "displayName": { "type": "string", "description": "Required. The user-defined name of the SpecialistPool. The name can be up to 128 characters long and can consist of any UTF-8 characters. This field should be unique on project-level." }, "pendingDataLabelingJobs": { "description": "Output only. The resource name of the pending data labeling jobs.", "type": "array", "items": { "type": "string" }, "readOnly": true }, "specialistManagerEmails": { "type": "array", "items": { "type": "string" }, "description": "The email addresses of the managers in the SpecialistPool." }, "specialistManagersCount": { "type": "integer", "format": "int32", "readOnly": true, "description": "Output only. The number of managers in this SpecialistPool." }, "name": { "description": "Required. The resource name of the SpecialistPool.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1SpecialistPool", "type": "object" }, "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsResponse": { "type": "object", "description": "Response message for EvaluationService.GenerateInstanceRubrics.", "properties": { "generatedRubrics": { "readOnly": true, "type": "array", "description": "Output only. A list of generated rubrics.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Rubric" } } }, "id": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsResponse" }, "GoogleCloudAiplatformV1beta1ListAgentAnomalyDetectionScopesResponse": { "type": "object", "description": "Response message for AgentAnomalyDetectionService.ListAgentAnomalyDetectionScopes.", "id": "GoogleCloudAiplatformV1beta1ListAgentAnomalyDetectionScopesResponse", "properties": { "agentAnomalyDetectionScopes": { "type": "array", "description": "A list of AgentAnomalyDetectionScopes that matches the specified filter in the request.", "items": { "$ref": "GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1LossTaxonomyEntry": { "properties": { "description": { "description": "A detailed description of this loss pattern. Example: \"The agent verbally confirms an action without executing the tool.\"", "type": "string" }, "l1Category": { "type": "string", "description": "The primary category of the loss (e.g., \"Hallucination\", \"Tool Calling\"). This field is typically required." }, "l2Category": { "description": "The secondary category of the loss (e.g., \"Hallucination of Action\", \"Incorrect Tool Selection\").", "type": "string" } }, "description": "Defines a specific entry in the loss pattern taxonomy.", "id": "GoogleCloudAiplatformV1beta1LossTaxonomyEntry", "type": "object" }, "GoogleCloudAiplatformV1beta1AugmentPromptResponse": { "type": "object", "description": "Response message for AugmentPrompt.", "properties": { "augmentedPrompt": { "description": "Augmented prompt, only text format is supported for now.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" } }, "facts": { "description": "Retrieved facts from RAG data sources.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Fact" } } }, "id": "GoogleCloudAiplatformV1beta1AugmentPromptResponse" }, "GoogleCloudAiplatformV1beta1JiraSource": { "id": "GoogleCloudAiplatformV1beta1JiraSource", "properties": { "jiraQueries": { "type": "array", "description": "Required. The Jira queries.", "items": { "$ref": "GoogleCloudAiplatformV1beta1JiraSourceJiraQueries" } } }, "description": "The Jira source for the ImportRagFilesRequest.", "type": "object" }, "GoogleCloudAiplatformV1beta1A2ATaskRecordHistoryAppend": { "description": "An event payload that appends a new message to the task history.", "type": "object", "properties": { "message": { "description": "Required. The message to append to the task history.", "$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordMessage" } }, "id": "GoogleCloudAiplatformV1beta1A2ATaskRecordHistoryAppend" }, "GoogleCloudAiplatformV1beta1ExplanationMetadataInputMetadataVisualization": { "type": "object", "description": "Visualization configurations for image explanation.", "id": "GoogleCloudAiplatformV1beta1ExplanationMetadataInputMetadataVisualization", "properties": { "polarity": { "description": "Whether to only highlight pixels with positive contributions, negative or both. Defaults to POSITIVE.", "enumDescriptions": [ "Default value. This is the same as POSITIVE.", "Highlights the pixels/outlines that were most influential to the model's prediction.", "Setting polarity to negative highlights areas that does not lead to the models's current prediction.", "Shows both positive and negative attributions." ], "type": "string", "enum": [ "POLARITY_UNSPECIFIED", "POSITIVE", "NEGATIVE", "BOTH" ] }, "clipPercentUpperbound": { "type": "number", "description": "Excludes attributions above the specified percentile from the highlighted areas. Using the clip_percent_upperbound and clip_percent_lowerbound together can be useful for filtering out noise and making it easier to see areas of strong attribution. Defaults to 99.9.", "format": "float" }, "overlayType": { "description": "How the original image is displayed in the visualization. Adjusting the overlay can help increase visual clarity if the original image makes it difficult to view the visualization. Defaults to NONE.", "type": "string", "enumDescriptions": [ "Default value. This is the same as NONE.", "No overlay.", "The attributions are shown on top of the original image.", "The attributions are shown on top of grayscaled version of the original image.", "The attributions are used as a mask to reveal predictive parts of the image and hide the un-predictive parts." ], "enum": [ "OVERLAY_TYPE_UNSPECIFIED", "NONE", "ORIGINAL", "GRAYSCALE", "MASK_BLACK" ] }, "type": { "description": "Type of the image visualization. Only applicable to Integrated Gradients attribution. OUTLINES shows regions of attribution, while PIXELS shows per-pixel attribution. Defaults to OUTLINES.", "enumDescriptions": [ "Should not be used.", "Shows which pixel contributed to the image prediction.", "Shows which region contributed to the image prediction by outlining the region." ], "enum": [ "TYPE_UNSPECIFIED", "PIXELS", "OUTLINES" ], "type": "string" }, "colorMap": { "type": "string", "enumDescriptions": [ "Should not be used.", "Positive: green. Negative: pink.", "Viridis color map: A perceptually uniform color mapping which is easier to see by those with colorblindness and progresses from yellow to green to blue. Positive: yellow. Negative: blue.", "Positive: red. Negative: red.", "Positive: green. Negative: green.", "Positive: green. Negative: red.", "PiYG palette." ], "enum": [ "COLOR_MAP_UNSPECIFIED", "PINK_GREEN", "VIRIDIS", "RED", "GREEN", "RED_GREEN", "PINK_WHITE_GREEN" ], "description": "The color scheme used for the highlighted areas. Defaults to PINK_GREEN for Integrated Gradients attribution, which shows positive attributions in green and negative in pink. Defaults to VIRIDIS for XRAI attribution, which highlights the most influential regions in yellow and the least influential in blue." }, "clipPercentLowerbound": { "type": "number", "format": "float", "description": "Excludes attributions below the specified percentile, from the highlighted areas. Defaults to 62." } } }, "GoogleCloudAiplatformV1beta1SchemaPredictParamsGroundingConfigSourceEntry": { "properties": { "vertexAiSearchDatastore": { "type": "string", "description": "The uri of the Vertex AI Search data source." }, "inlineContext": { "type": "string", "description": "The grounding text passed inline with the Predict API. It can support up to 1 million bytes." }, "type": { "type": "string", "enumDescriptions": [ "", "Uses Web Search to check the grounding.", "Uses Vertex AI Search to check the grounding. Deprecated. Use VERTEX_AI_SEARCH instead.", "Uses Vertex AI Search to check the grounding", "Uses inline context to check the grounding." ], "description": "The type of the grounding checking source.", "enum": [ "UNSPECIFIED", "WEB", "ENTERPRISE", "VERTEX_AI_SEARCH", "INLINE" ], "enumDeprecated": [ false, false, true, false, false ] }, "enterpriseDatastore": { "type": "string", "description": "The uri of the Vertex AI Search data source. Deprecated. Use vertex_ai_search_datastore instead.", "deprecated": true } }, "description": "Single source entry for the grounding checking.", "id": "GoogleCloudAiplatformV1beta1SchemaPredictParamsGroundingConfigSourceEntry", "type": "object" }, "GoogleCloudAiplatformV1beta1SummarizationHelpfulnessSpec": { "id": "GoogleCloudAiplatformV1beta1SummarizationHelpfulnessSpec", "properties": { "version": { "type": "integer", "format": "int32", "description": "Optional. Which version to use for evaluation." }, "useReference": { "type": "boolean", "description": "Optional. Whether to use instance.reference to compute summarization helpfulness." } }, "type": "object", "description": "Spec for summarization helpfulness score metric." }, "GoogleCloudAiplatformV1beta1CheckPublisherModelEulaAcceptanceRequest": { "id": "GoogleCloudAiplatformV1beta1CheckPublisherModelEulaAcceptanceRequest", "description": "Request message for ModelGardenService.CheckPublisherModelEula.", "type": "object", "properties": { "publisherModel": { "description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}`", "type": "string" } } }, "GoogleCloudAiplatformV1beta1CreatePipelineJobRequest": { "id": "GoogleCloudAiplatformV1beta1CreatePipelineJobRequest", "description": "Request message for PipelineService.CreatePipelineJob.", "properties": { "pipelineJob": { "$ref": "GoogleCloudAiplatformV1beta1PipelineJob", "description": "Required. The PipelineJob to create." }, "pipelineJobId": { "description": "The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`.", "type": "string" }, "parent": { "description": "Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ListA2ATaskRecordsResponse": { "description": "Response message for A2ATaskRecordService.ListA2ATaskRecords.", "properties": { "a2aTaskRecords": { "items": { "$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecord" }, "type": "array", "description": "List of A2ATaskRecords in the requested page." }, "nextPageToken": { "description": "A token, which can be sent as A2ATaskRecordService.ListA2ATaskRecordsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1ListA2ATaskRecordsResponse", "type": "object" }, "GenaiVertexV1beta1VideoConfig": { "id": "GenaiVertexV1beta1VideoConfig", "type": "object", "properties": { "task": { "enum": [ "TASK_UNSPECIFIED", "TEXT_TO_VIDEO", "IMAGE_TO_VIDEO", "REFERENCE_TO_VIDEO", "EDIT", "EXTEND" ], "type": "string", "enumDescriptions": [ "Unspecified task. The task is inferred from the input prompt and media.", "Generates video solely from a text prompt.", "Generates video from one or two source images. The first image defines the starting frame, and the optional second image defines the ending frame.", "Generates video using reference media (such as images, audio, or video).", "Modifies an existing input video.", "Extends an existing input video." ], "description": "Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media." } }, "description": "Configuration options for video generation." }, "GoogleCloudAiplatformV1beta1CreateDatasetVersionOperationMetadata": { "description": "Runtime operation information for DatasetService.CreateDatasetVersion.", "properties": { "genericMetadata": { "description": "The common part of the operation metadata.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1CreateDatasetVersionOperationMetadata" }, "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequestSimpleRetrievalParams": { "description": "Parameters for simple (non-similarity search) retrieval.", "id": "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequestSimpleRetrievalParams", "properties": { "pageSize": { "format": "int32", "type": "integer", "description": "Optional. The maximum number of memories to return. The service may return fewer than this value. If unspecified, at most 3 memories will be returned. The maximum value is 100; values above 100 will be coerced to 100." }, "pageToken": { "description": "Optional. A page token, received from a previous `RetrieveMemories` call. Provide this to retrieve the subsequent page.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1FeatureSelector": { "type": "object", "id": "GoogleCloudAiplatformV1beta1FeatureSelector", "description": "Selector for Features of an EntityType.", "properties": { "idMatcher": { "description": "Required. Matches Features based on ID.", "$ref": "GoogleCloudAiplatformV1beta1IdMatcher" } } }, "GoogleCloudAiplatformV1beta1RuntimeConfigVertexAISearchRuntimeConfig": { "properties": { "servingConfigName": { "description": "Optional. Vertex AI Search serving config name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}`", "type": "string" }, "engineId": { "type": "string", "description": "Optional. Vertex AI Search engine ID. This is used to construct the search request. By setting this engine_id, API will construct the serving config using the default value to call search API for the user. The engine_id and serving_config_name cannot both be empty at the same time." } }, "id": "GoogleCloudAiplatformV1beta1RuntimeConfigVertexAISearchRuntimeConfig", "type": "object" }, "GoogleCloudAiplatformV1beta1TaskMessage": { "id": "GoogleCloudAiplatformV1beta1TaskMessage", "description": "Represents a single message in a conversation, compliant with the A2A specification.", "type": "object", "properties": { "parts": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Part" }, "type": "array", "description": "Required. The parts of the message." }, "metadata": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object", "description": "Optional. A2A message may have extension_uris or reference_task_ids. They will be stored under metadata." }, "messageId": { "description": "Required. The unique identifier of the message.", "type": "string" }, "role": { "description": "Required. The role of the sender of the message. e.g. \"user\", \"agent\"", "type": "string" } } }, "GoogleCloudAiplatformV1beta1CreateSolverOperationMetadata": { "id": "GoogleCloudAiplatformV1beta1CreateSolverOperationMetadata", "type": "object", "properties": { "genericMetadata": { "description": "The generic operation information.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "description": "Runtime operation information for SolverService.CreateSolver." }, "GoogleCloudAiplatformV1beta1FeatureNoiseSigmaNoiseSigmaForFeature": { "properties": { "sigma": { "type": "number", "description": "This represents the standard deviation of the Gaussian kernel that will be used to add noise to the feature prior to computing gradients. Similar to noise_sigma but represents the noise added to the current feature. Defaults to 0.1.", "format": "float" }, "name": { "description": "The name of the input feature for which noise sigma is provided. The features are defined in explanation metadata inputs.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1FeatureNoiseSigmaNoiseSigmaForFeature", "description": "Noise sigma for a single feature.", "type": "object" }, "GoogleCloudAiplatformV1beta1OnlineEvaluatorConfig": { "properties": { "maxEvaluatedSamplesPerRun": { "format": "int64", "description": "Optional. The maximum number of evaluations to perform per run. If set to 0, the number is unbounded.", "type": "string" }, "randomSampling": { "description": "Random sampling method.", "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorConfigRandomSampling" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1OnlineEvaluatorConfig", "description": "Configuration for sampling behavior of the OnlineEvaluator. The OnlineEvaluator runs at a fixed interval of 10 minutes." }, "GoogleCloudAiplatformV1beta1Explanation": { "description": "Explanation of a prediction (provided in PredictResponse.predictions) produced by the Model on a given instance.", "id": "GoogleCloudAiplatformV1beta1Explanation", "type": "object", "properties": { "attributions": { "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Attribution" }, "description": "Output only. Feature attributions grouped by predicted outputs. For Models that predict only one output, such as regression Models that predict only one score, there is only one attibution that explains the predicted output. For Models that predict multiple outputs, such as multiclass Models that predict multiple classes, each element explains one specific item. Attribution.output_index can be used to identify which output this attribution is explaining. By default, we provide Shapley values for the predicted class. However, you can configure the explanation request to generate Shapley values for any other classes too. For example, if a model predicts a probability of `0.4` for approving a loan application, the model's decision is to reject the application since `p(reject) = 0.6 \u003e p(approve) = 0.4`, and the default Shapley values would be computed for rejection decision and not approval, even though the latter might be the positive class. If users set ExplanationParameters.top_k, the attributions are sorted by instance_output_value in descending order. If ExplanationParameters.output_indices is specified, the attributions are stored by Attribution.output_index in the same order as they appear in the output_indices." }, "neighbors": { "readOnly": true, "items": { "$ref": "GoogleCloudAiplatformV1beta1Neighbor" }, "type": "array", "description": "Output only. List of the nearest neighbors for example-based explanations. For models deployed with the examples explanations feature enabled, the attributions field is empty and instead the neighbors field is populated." } } }, "GoogleCloudAiplatformV1beta1ExamplesOverride": { "id": "GoogleCloudAiplatformV1beta1ExamplesOverride", "description": "Overrides for example-based explanations.", "properties": { "dataFormat": { "enumDescriptions": [ "Unspecified format. Must not be used.", "Provided data is a set of model inputs.", "Provided data is a set of embeddings." ], "type": "string", "enum": [ "DATA_FORMAT_UNSPECIFIED", "INSTANCES", "EMBEDDINGS" ], "description": "The format of the data being provided with each call." }, "restrictions": { "description": "Restrict the resulting nearest neighbors to respect these constraints.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ExamplesRestrictionsNamespace" }, "type": "array" }, "neighborCount": { "type": "integer", "description": "The number of neighbors to return.", "format": "int32" }, "returnEmbeddings": { "type": "boolean", "description": "If true, return the embeddings instead of neighbors." }, "crowdingCount": { "type": "integer", "format": "int32", "description": "The number of neighbors to return that have the same crowding tag." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1FeatureViewIndexConfigTreeAHConfig": { "id": "GoogleCloudAiplatformV1beta1FeatureViewIndexConfigTreeAHConfig", "description": "Configuration options for the tree-AH algorithm.", "properties": { "leafNodeEmbeddingCount": { "format": "int64", "type": "string", "description": "Optional. Number of embeddings on each leaf node. The default value is 1000 if not set." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1RebootPersistentResourceRequest": { "id": "GoogleCloudAiplatformV1beta1RebootPersistentResourceRequest", "type": "object", "properties": {}, "description": "Request message for PersistentResourceService.RebootPersistentResource." }, "GoogleCloudAiplatformV1beta1AssessDataRequestBatchPredictionValidationAssessmentConfig": { "type": "object", "description": "Configuration for the batch prediction validation assessment.", "properties": { "modelName": { "description": "Required. The name of the model used for batch prediction.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1AssessDataRequestBatchPredictionValidationAssessmentConfig" }, "GoogleCloudAiplatformV1beta1NearestNeighborsNeighbor": { "id": "GoogleCloudAiplatformV1beta1NearestNeighborsNeighbor", "properties": { "entityKeyValues": { "description": "The attributes of the neighbor, e.g. filters, crowding and metadata Note that full entities are returned only when \"return_full_entity\" is set to true. Otherwise, only the \"entity_id\" and \"distance\" fields are populated.", "$ref": "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponse" }, "entityId": { "type": "string", "description": "The id of the similar entity." }, "distance": { "description": "The distance between the neighbor and the query vector.", "type": "number", "format": "double" } }, "type": "object", "description": "A neighbor of the query vector." }, "GoogleCloudAiplatformV1beta1ReportExecutionEventRequest": { "type": "object", "description": "Request message for NotebookInternalService.ReportExecutionEvent.", "properties": { "eventType": { "description": "Required. The type of the event.", "enum": [ "EVENT_TYPE_UNSPECIFIED", "ACTIVE", "DONE", "FAILED" ], "enumDescriptions": [ "Unspecified.", "Notebook execution process has started. Expect this message within expected time to provision compute.", "Notebook execution process is completed. Expect this message within timeout.", "Notebook execution process has failed. Expect this message within timeout." ], "type": "string" }, "status": { "$ref": "GoogleRpcStatus", "description": "Optional. The error details of the event." }, "vmToken": { "description": "Required. The VM identity token (a JWT) for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1ReportExecutionEventRequest" }, "GoogleCloudAiplatformV1beta1QuestionAnsweringRelevanceSpec": { "id": "GoogleCloudAiplatformV1beta1QuestionAnsweringRelevanceSpec", "description": "Spec for question answering relevance metric.", "properties": { "useReference": { "description": "Optional. Whether to use instance.reference to compute question answering relevance.", "type": "boolean" }, "version": { "description": "Optional. Which version to use for evaluation.", "type": "integer", "format": "int32" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1NearestNeighborQueryStringFilter": { "properties": { "allowTokens": { "items": { "type": "string" }, "description": "Optional. The allowed tokens.", "type": "array" }, "name": { "description": "Required. Column names in BigQuery that used as filters.", "type": "string" }, "denyTokens": { "items": { "type": "string" }, "type": "array", "description": "Optional. The denied tokens." } }, "description": "String filter is used to search a subset of the entities by using boolean rules on string columns. For example: if a query specifies string filter with 'name = color, allow_tokens = {red, blue}, deny_tokens = {purple}',' then that query will match entities that are red or blue, but if those points are also purple, then they will be excluded even if they are red/blue. Only string filter is supported for now, numeric filter will be supported in the near future.", "type": "object", "id": "GoogleCloudAiplatformV1beta1NearestNeighborQueryStringFilter" }, "GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeVmImage": { "properties": { "name": { "description": "Use this VM image name to find the image.", "type": "string" }, "family": { "description": "Use this VM image family to find the image; the newest image in this family is used.", "type": "string" }, "project": { "description": "Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`.", "type": "string" } }, "description": "The definition of a Compute Engine VM image to run the notebook execution on. Mirrors `google.cloud.notebooks.v2.VmImage`.", "id": "GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeVmImage", "type": "object" }, "GoogleCloudAiplatformV1beta1TaskStateChange": { "id": "GoogleCloudAiplatformV1beta1TaskStateChange", "description": "A message representing a change in a task's state.", "type": "object", "properties": { "newState": { "enumDescriptions": [ "Task state unspecified. Default value if not set.", "Task is submitted and waiting to be processed.", "Task is actively being processed.", "Task is finished.", "Task is cancelled.", "Task has failed.", "Task is rejected by the system.", "Task requires input from the user.", "Task requires auth (e.g. OAuth) from the user.", "Task is paused." ], "description": "Required. The new state of the task.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "SUBMITTED", "WORKING", "COMPLETED", "CANCELLED", "FAILED", "REJECTED", "INPUT_REQUIRED", "AUTH_REQUIRED", "PAUSED" ] } } }, "GenaiVertexV1beta1FileSearchResultContentFileSearchResult": { "id": "GenaiVertexV1beta1FileSearchResultContentFileSearchResult", "type": "object", "description": "The result of the File Search.", "properties": {} }, "GoogleCloudAiplatformV1beta1PauseSandboxEnvironmentRequest": { "id": "GoogleCloudAiplatformV1beta1PauseSandboxEnvironmentRequest", "properties": {}, "description": "Request message for SandboxEnvironmentService.PauseSandboxEnvironment.", "type": "object" }, "GoogleCloudAiplatformV1beta1FeatureViewSyncSyncSummary": { "type": "object", "properties": { "systemWatermarkTime": { "description": "Lower bound of the system time watermark for the sync job. This is only set for continuously syncing feature views.", "type": "string", "format": "google-datetime" }, "rowSynced": { "format": "int64", "description": "Output only. Total number of rows synced.", "readOnly": true, "type": "string" }, "totalSlot": { "format": "int64", "type": "string", "readOnly": true, "description": "Output only. BigQuery slot milliseconds consumed for the sync job." } }, "description": "Summary from the Sync job. For continuous syncs, the summary is updated periodically. For batch syncs, it gets updated on completion of the sync.", "id": "GoogleCloudAiplatformV1beta1FeatureViewSyncSyncSummary" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata": { "type": "object", "properties": { "backingHyperparameterTuningJob": { "type": "string", "description": "The resource name of the HyperparameterTuningJob that has been created to carry out this HyperparameterTuning task." }, "bestTrialBackingCustomJob": { "description": "The resource name of the CustomJob that has been created to run the best Trial of this HyperparameterTuning task.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata" }, "GoogleCloudAiplatformV1beta1CreateEntityTypeOperationMetadata": { "description": "Details of operations that perform create EntityType.", "type": "object", "properties": { "genericMetadata": { "description": "Operation metadata for EntityType.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "id": "GoogleCloudAiplatformV1beta1CreateEntityTypeOperationMetadata" }, "GoogleCloudAiplatformV1beta1UpdateModelDeploymentMonitoringJobOperationMetadata": { "type": "object", "properties": { "genericMetadata": { "description": "The operation generic information.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "id": "GoogleCloudAiplatformV1beta1UpdateModelDeploymentMonitoringJobOperationMetadata", "description": "Runtime operation information for JobService.UpdateModelDeploymentMonitoringJob." }, "GoogleCloudAiplatformV1beta1PredictRequestResponseLoggingConfig": { "id": "GoogleCloudAiplatformV1beta1PredictRequestResponseLoggingConfig", "type": "object", "properties": { "enabled": { "description": "If logging is enabled or not.", "type": "boolean" }, "enableOtelLogging": { "type": "boolean", "description": "This field is used for large models. If true, in addition to the original large model logs, logs will be converted in OTel schema format, and saved in otel_log column. Default value is false." }, "requestResponseLoggingSchemaVersion": { "description": "Output only. The schema version used in creating the BigQuery table for the request response logging. The versions are \"v1\" and \"v2\". The current default version is \"v1\".", "type": "string", "readOnly": true }, "samplingRate": { "type": "number", "format": "double", "description": "Percentage of requests to be logged, expressed as a fraction in range(0,1]." }, "bigqueryDestination": { "description": "BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging`", "$ref": "GoogleCloudAiplatformV1beta1BigQueryDestination" }, "errorSamplingRate": { "type": "number", "format": "double", "description": "Optional. Percentage of failed requests to be logged, expressed as a fraction in range [0,1]. Only non-transient errors will be logged (currently `500/Internal` errors)." } }, "description": "Configuration for logging request-response to a BigQuery table." }, "GoogleCloudAiplatformV1beta1TrajectoryRecallMetricValue": { "type": "object", "description": "TrajectoryRecall metric value for an instance.", "properties": { "score": { "format": "float", "description": "Output only. TrajectoryRecall score.", "type": "number", "readOnly": true } }, "id": "GoogleCloudAiplatformV1beta1TrajectoryRecallMetricValue" }, "GoogleCloudAiplatformV1beta1RebootPersistentResourceOperationMetadata": { "type": "object", "id": "GoogleCloudAiplatformV1beta1RebootPersistentResourceOperationMetadata", "properties": { "genericMetadata": { "description": "Operation metadata for PersistentResource.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" }, "progressMessage": { "description": "Progress Message for Reboot LRO", "type": "string" } }, "description": "Details of operations that perform reboot PersistentResource." }, "GoogleCloudAiplatformV1beta1ListDataItemsResponse": { "description": "Response message for DatasetService.ListDataItems.", "properties": { "dataItems": { "items": { "$ref": "GoogleCloudAiplatformV1beta1DataItem" }, "description": "A list of DataItems that matches the specified filter in the request.", "type": "array" }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ListDataItemsResponse" }, "GoogleCloudAiplatformV1beta1GatewayConfig": { "type": "object", "properties": { "dnsRecord": { "description": "Output only. The fully qualified record name of the created A-record in Cloud DNS.", "type": "string", "readOnly": true }, "allowedProjects": { "type": "array", "items": { "type": "string" }, "description": "Optional. Additional consumer projects permitted to attach their own PSC endpoint to this gateway's ServiceAttachment. This is the \"decoupled\" mode, where the customer creates the PSC endpoint in a project other than this gateway's `network` project. Each listed project is VPC-SC enforced: it must be within the caller's service perimeter. The owning SemanticGovernancePolicyEngine's own project is always permitted implicitly and need not be listed. Format: `projects/{project}` (ID or number)." }, "pscEndpoint": { "description": "Output only. The self-link or name of the Private Service Connect endpoint forwarding rule.", "readOnly": true, "type": "string" }, "ipAddress": { "type": "string", "readOnly": true, "description": "Output only. The private IP address of the PSC endpoint." }, "state": { "description": "Output only. The state of the Gateway configuration.", "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "ACTIVE", "DEPROVISIONING", "INACTIVE", "FAILED" ], "readOnly": true, "type": "string", "enumDescriptions": [ "The default value. This value is used if the state is omitted.", "The Gateway is being provisioned.", "The Gateway is active and ready to use.", "The Gateway is being de-provisioned.", "The Gateway is inactive.", "The Gateway failed to be provisioned." ] }, "dnsZoneName": { "description": "Optional. Name of the private Cloud DNS managed zone in which to create the gateway's A-record. This is the managed zone's own name, not its DNS name: for a zone serving `example.internal.`, this field takes the zone name, such as `my-private-zone`. The zone's DNS name is combined with a generated per-gateway label to form the record's fully qualified name, which must stay within the 255-octet DNS limit. If the full name is too long, gateway provisioning fails when it attempts to create the DNS record.", "type": "string" }, "subnetwork": { "description": "Optional. The URI of the subnetwork resource where PSC-E will be provisioned. if not provided `default` subnet will be used from the same {location} Format: projects/{project}/regions/{region}/subnetworks/{subnetwork}", "type": "string" }, "network": { "description": "Optional. The URI of the network resource where PSC-E will be provisioned. if not provided `default` network will be used. Format: projects/{project}/global/networks/{network}", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1GatewayConfig", "description": "Configuration for a single gateway." }, "GoogleCloudAiplatformV1beta1BatchMigrateResourcesRequest": { "description": "Request message for MigrationService.BatchMigrateResources.", "id": "GoogleCloudAiplatformV1beta1BatchMigrateResourcesRequest", "properties": { "migrateResourceRequests": { "type": "array", "description": "Required. The request messages specifying the resources to migrate. They must be in the same location as the destination. Up to 50 resources can be migrated in one batch.", "items": { "$ref": "GoogleCloudAiplatformV1beta1MigrateResourceRequest" } } }, "type": "object" }, "GoogleCloudAiplatformV1beta1NearestNeighbors": { "properties": { "neighbors": { "type": "array", "description": "All its neighbors.", "items": { "$ref": "GoogleCloudAiplatformV1beta1NearestNeighborsNeighbor" } } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1NearestNeighbors", "description": "Nearest neighbors for one query." }, "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigHybridSearchConfig": { "type": "object", "id": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigHybridSearchConfig", "properties": { "denseEmbeddingModelPredictionEndpoint": { "$ref": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigVertexPredictionEndpoint", "description": "Required. The Vertex AI Prediction Endpoint that hosts the embedding model for dense embedding generations." }, "sparseEmbeddingConfig": { "$ref": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigSparseEmbeddingConfig", "description": "Optional. The configuration for sparse embedding generation. This field is optional the default behavior depends on the vector database choice on the RagCorpus." } }, "description": "Config for hybrid search." }, "GoogleCloudAiplatformV1beta1CheckTrialEarlyStoppingStateRequest": { "type": "object", "id": "GoogleCloudAiplatformV1beta1CheckTrialEarlyStoppingStateRequest", "description": "Request message for VizierService.CheckTrialEarlyStoppingState.", "properties": {} }, "GoogleCloudAiplatformV1beta1PointwiseMetricResult": { "type": "object", "id": "GoogleCloudAiplatformV1beta1PointwiseMetricResult", "description": "Spec for pointwise metric result.", "properties": { "explanation": { "description": "Output only. Explanation for pointwise metric score.", "readOnly": true, "type": "string" }, "score": { "type": "number", "description": "Output only. Pointwise metric score.", "readOnly": true, "format": "float" }, "customOutput": { "$ref": "GoogleCloudAiplatformV1beta1CustomOutput", "readOnly": true, "description": "Output only. Spec for custom output." } } }, "GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigTtlConfigGranularTtlConfig": { "id": "GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigTtlConfigGranularTtlConfig", "properties": { "createTtl": { "type": "string", "format": "google-duration", "description": "Optional. The TTL duration for memories uploaded via CreateMemory." }, "generateCreatedTtl": { "format": "google-duration", "type": "string", "description": "Optional. The TTL duration for memories newly generated via GenerateMemories (GenerateMemoriesResponse.GeneratedMemory.Action.CREATED)." }, "generateUpdatedTtl": { "type": "string", "format": "google-duration", "description": "Optional. The TTL duration for memories updated via GenerateMemories (GenerateMemoriesResponse.GeneratedMemory.Action.UPDATED). In the case of an UPDATE action, the `expire_time` of the existing memory will be updated to the new value (now + TTL)." } }, "type": "object", "description": "Configuration for TTL of the memories in the Memory Bank based on the action that created or updated the memory." }, "GoogleCloudAiplatformV1beta1GenerateSyntheticDataResponse": { "type": "object", "properties": { "syntheticExamples": { "description": "A list of generated synthetic examples, each containing a complete synthetic data instance generated based on your request.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1SyntheticExample" } } }, "description": "The response message for the `GenerateSyntheticData` method, containing the synthetic examples generated by the Gen AI evaluation service.", "id": "GoogleCloudAiplatformV1beta1GenerateSyntheticDataResponse" }, "GoogleCloudAiplatformV1beta1MemoryGenerationTriggerConfig": { "properties": { "generationRule": { "description": "Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately.", "$ref": "GoogleCloudAiplatformV1beta1MemoryGenerationTriggerConfigGenerationTriggerRule" } }, "id": "GoogleCloudAiplatformV1beta1MemoryGenerationTriggerConfig", "description": "Represents configuration for triggering generation.", "type": "object" }, "CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox": { "id": "CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox", "properties": { "x1": { "type": "integer", "description": "The X coordinate of the top-left corner, in pixels.", "format": "int32" }, "x2": { "type": "integer", "description": "The X coordinate of the bottom-right corner, in pixels.", "format": "int32" }, "y1": { "format": "int32", "description": "The Y coordinate of the top-left corner, in pixels.", "type": "integer" }, "y2": { "type": "integer", "format": "int32", "description": "The Y coordinate of the bottom-right corner, in pixels." } }, "description": "An integer bounding box of original pixels of the image for the detected labels.", "type": "object" }, "GoogleCloudAiplatformV1beta1ExportModelOperationMetadata": { "type": "object", "description": "Details of ModelService.ExportModel operation.", "properties": { "genericMetadata": { "description": "The common part of the operation metadata.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" }, "outputInfo": { "description": "Output only. Information further describing the output of this Model export.", "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1ExportModelOperationMetadataOutputInfo" } }, "id": "GoogleCloudAiplatformV1beta1ExportModelOperationMetadata" }, "GoogleCloudAiplatformV1beta1SchemaPredictPredictionVideoActionRecognitionPredictionResult": { "description": "Prediction output format for Video Action Recognition.", "properties": { "id": { "description": "The resource ID of the AnnotationSpec that had been identified.", "type": "string" }, "timeSegmentEnd": { "format": "google-duration", "description": "The end, exclusive, of the video's time segment in which the AnnotationSpec has been identified. Expressed as a number of seconds as measured from the start of the video, with fractions up to a microsecond precision, and with \"s\" appended at the end.", "type": "string" }, "timeSegmentStart": { "description": "The beginning, inclusive, of the video's time segment in which the AnnotationSpec has been identified. Expressed as a number of seconds as measured from the start of the video, with fractions up to a microsecond precision, and with \"s\" appended at the end.", "type": "string", "format": "google-duration" }, "confidence": { "type": "number", "description": "The Model's confidence in correction of this prediction, higher value means higher confidence.", "format": "float" }, "displayName": { "description": "The display name of the AnnotationSpec that had been identified.", "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaPredictPredictionVideoActionRecognitionPredictionResult" }, "GenaiVertexV1beta1InteractionCreatedSseEvent": { "id": "GenaiVertexV1beta1InteractionCreatedSseEvent", "type": "object", "properties": { "interaction": { "$ref": "GenaiVertexV1beta1Interaction" } } }, "GoogleCloudAiplatformV1beta1SchemaPredictPredictionTabularClassificationPredictionResult": { "description": "Prediction output format for Tabular Classification.", "properties": { "classes": { "description": "The name of the classes being classified, contains all possible values of the target column.", "items": { "type": "string" }, "type": "array" }, "scores": { "items": { "type": "number", "format": "float" }, "description": "The model's confidence in each class being correct, higher value means higher confidence. The N-th score corresponds to the N-th class in classes.", "type": "array" } }, "id": "GoogleCloudAiplatformV1beta1SchemaPredictPredictionTabularClassificationPredictionResult", "type": "object" }, "GoogleCloudAiplatformV1beta1RagManagedDbConfigServerless": { "id": "GoogleCloudAiplatformV1beta1RagManagedDbConfigServerless", "properties": {}, "type": "object", "description": "Message to configure the serverless mode offered by RAG Engine." }, "GoogleCloudAiplatformV1beta1RagCorpusCorpusTypeConfigDocumentCorpus": { "properties": {}, "id": "GoogleCloudAiplatformV1beta1RagCorpusCorpusTypeConfigDocumentCorpus", "type": "object", "description": "Config for the document corpus." }, "GoogleCloudAiplatformV1beta1SummarizationVerbosityInstance": { "description": "Spec for summarization verbosity instance.", "id": "GoogleCloudAiplatformV1beta1SummarizationVerbosityInstance", "properties": { "prediction": { "description": "Required. Output of the evaluated model.", "type": "string" }, "context": { "type": "string", "description": "Required. Text to be summarized." }, "instruction": { "type": "string", "description": "Optional. Summarization prompt for LLM." }, "reference": { "type": "string", "description": "Optional. Ground truth used to compare against the prediction." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1EvaluationRunDataSource": { "id": "GoogleCloudAiplatformV1beta1EvaluationRunDataSource", "description": "The data source for the evaluation run.", "properties": { "evaluationSet": { "description": "The EvaluationSet resource name. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", "type": "string" }, "bigqueryRequestSet": { "description": "Evaluation data in bigquery.", "$ref": "GoogleCloudAiplatformV1beta1BigQueryRequestSet" } }, "type": "object" }, "GenaiVertexV1beta1RetrievalCallStepRetrievalStepArguments": { "properties": { "queries": { "description": "Queries for Retrieval information.", "type": "array", "items": { "type": "string" } } }, "id": "GenaiVertexV1beta1RetrievalCallStepRetrievalStepArguments", "description": "The arguments to pass to Retrieval tools.", "type": "object" }, "GoogleCloudAiplatformV1beta1StoredContentsExampleSearchKeyGenerationMethod": { "properties": { "lastEntry": { "description": "Use only the last entry of the conversation history (`contents_example.contents`) as the search key.", "$ref": "GoogleCloudAiplatformV1beta1StoredContentsExampleSearchKeyGenerationMethodLastEntry" } }, "description": "Options for generating the search key from the conversation history.", "id": "GoogleCloudAiplatformV1beta1StoredContentsExampleSearchKeyGenerationMethod", "type": "object" }, "GoogleCloudAiplatformV1beta1DeploySolverOperationMetadata": { "id": "GoogleCloudAiplatformV1beta1DeploySolverOperationMetadata", "description": "Runtime operation information for SolverService.DeploySolver.", "type": "object", "properties": { "genericMetadata": { "description": "The generic operation information.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } } }, "GoogleCloudAiplatformV1beta1DeleteFeatureValuesRequestSelectTimeRangeAndFeature": { "description": "Message to select time range and feature. Values of the selected feature generated within an inclusive time range will be deleted. Using this option permanently deletes the feature values from the specified feature IDs within the specified time range. This might include data from the online storage. If you want to retain any deleted historical data in the online storage, you must re-ingest it.", "properties": { "skipOnlineStorageDelete": { "description": "If set, data will not be deleted from online storage. When time range is older than the data in online storage, setting this to be true will make the deletion have no impact on online serving.", "type": "boolean" }, "timeRange": { "description": "Required. Select feature generated within a half-inclusive time range. The time range is lower inclusive and upper exclusive.", "$ref": "GoogleTypeInterval" }, "featureSelector": { "description": "Required. Selectors choosing which feature values to be deleted from the EntityType.", "$ref": "GoogleCloudAiplatformV1beta1FeatureSelector" } }, "id": "GoogleCloudAiplatformV1beta1DeleteFeatureValuesRequestSelectTimeRangeAndFeature", "type": "object" }, "GoogleCloudAiplatformV1beta1ReasoningEngineTrafficConfigTrafficSplitAlwaysLatest": { "properties": {}, "description": "Traffic distribution configuration, where all traffic is sent to the latest Runtime Revision.", "id": "GoogleCloudAiplatformV1beta1ReasoningEngineTrafficConfigTrafficSplitAlwaysLatest", "type": "object" }, "GoogleCloudAiplatformV1beta1ComputeTokensRequest": { "type": "object", "description": "Request message for ComputeTokens RPC call.", "properties": { "instances": { "description": "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.", "items": { "type": "any" }, "type": "array" }, "model": { "description": "Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*", "type": "string" }, "contents": { "description": "Optional. Input content.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" } } }, "id": "GoogleCloudAiplatformV1beta1ComputeTokensRequest" }, "GoogleCloudAiplatformV1beta1ExtensionManifestApiSpec": { "type": "object", "properties": { "openApiYaml": { "type": "string", "description": "The API spec in Open API standard and YAML format." }, "openApiGcsUri": { "type": "string", "description": "Cloud Storage URI pointing to the OpenAPI spec." } }, "description": "The API specification shown to the LLM.", "id": "GoogleCloudAiplatformV1beta1ExtensionManifestApiSpec" }, "GoogleCloudAiplatformV1beta1OnlineEvaluatorStateDetails": { "id": "GoogleCloudAiplatformV1beta1OnlineEvaluatorStateDetails", "properties": { "message": { "description": "Output only. Human-readable message describing the state of the OnlineEvaluator.", "readOnly": true, "type": "string" } }, "description": "Contains additional information about the state of the OnlineEvaluator.", "type": "object" }, "GoogleCloudAiplatformV1beta1StudySpecParameterSpecCategoricalValueSpec": { "properties": { "defaultValue": { "type": "string", "description": "A default value for a `CATEGORICAL` parameter that is assumed to be a relatively good starting point. Unset value signals that there is no offered starting point. Currently only supported by the Vertex AI Vizier service. Not supported by HyperparameterTuningJob or TrainingPipeline." }, "values": { "type": "array", "description": "Required. The list of possible categories.", "items": { "type": "string" } } }, "description": "Value specification for a parameter in `CATEGORICAL` type.", "type": "object", "id": "GoogleCloudAiplatformV1beta1StudySpecParameterSpecCategoricalValueSpec" }, "GoogleCloudAiplatformV1beta1PersistentResource": { "type": "object", "properties": { "pscInterfaceConfig": { "description": "Optional. Configuration for PSC-I for PersistentResource.", "$ref": "GoogleCloudAiplatformV1beta1PscInterfaceConfig" }, "name": { "description": "Immutable. Resource name of a PersistentResource.", "type": "string" }, "updateTime": { "readOnly": true, "description": "Output only. Time when the PersistentResource was most recently updated.", "type": "string", "format": "google-datetime" }, "resourceRuntimeSpec": { "description": "Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration.", "$ref": "GoogleCloudAiplatformV1beta1ResourceRuntimeSpec" }, "satisfiesPzi": { "type": "boolean", "readOnly": true, "description": "Output only. Reserved for future use." }, "network": { "description": "Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network.", "type": "string" }, "encryptionSpec": { "description": "Optional. Customer-managed encryption key spec for a PersistentResource. If set, this PersistentResource and all sub-resources of this PersistentResource will be secured by this key.", "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec" }, "resourceRuntime": { "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1ResourceRuntime", "description": "Output only. Runtime information of the Persistent Resource." }, "state": { "description": "Output only. The detailed state of a Study.", "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "RUNNING", "STOPPING", "ERROR", "REBOOTING", "UPDATING" ], "enumDescriptions": [ "Not set.", "The PROVISIONING state indicates the persistent resources is being created.", "The RUNNING state indicates the persistent resource is healthy and fully usable.", "The STOPPING state indicates the persistent resource is being deleted.", "The ERROR state indicates the persistent resource may be unusable. Details can be found in the `error` field.", "The REBOOTING state indicates the persistent resource is being rebooted (PR is not available right now but is expected to be ready again later).", "The UPDATING state indicates the persistent resource is being updated." ], "readOnly": true, "type": "string" }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" }, "reservedIpRanges": { "description": "Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].", "items": { "type": "string" }, "type": "array" }, "labels": { "description": "Optional. The labels with user-defined metadata to organize PersistentResource. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.", "type": "object", "additionalProperties": { "type": "string" } }, "startTime": { "type": "string", "description": "Output only. Time when the PersistentResource for the first time entered the `RUNNING` state.", "format": "google-datetime", "readOnly": true }, "resourcePools": { "description": "Required. The spec of the pools of different resources.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1ResourcePool" } }, "createTime": { "description": "Output only. Time when the PersistentResource was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "error": { "description": "Output only. Only populated when persistent resource's state is `STOPPING` or `ERROR`.", "$ref": "GoogleRpcStatus", "readOnly": true }, "displayName": { "type": "string", "description": "Optional. The display name of the PersistentResource. The name can be up to 128 characters long and can consist of any UTF-8 characters." } }, "description": "Represents long-lasting resources that are dedicated to users to runs custom workloads. A PersistentResource can have multiple node pools and each node pool can have its own machine spec.", "id": "GoogleCloudAiplatformV1beta1PersistentResource" }, "GoogleCloudAiplatformV1beta1SchemaPromptSpecStructuredPrompt": { "properties": { "infillSuffix": { "description": "Preamble: For infill prompt, the suffix after expected model response.", "type": "string" }, "promptMessage": { "description": "The prompt message.", "$ref": "GoogleCloudAiplatformV1beta1SchemaPromptSpecPromptMessage" }, "infillPrefix": { "description": "Preamble: For infill prompt, the prefix before expected model response.", "type": "string" }, "examples": { "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaPromptSpecPartList" }, "description": "Preamble: A set of examples for expected model response.", "type": "array" }, "interactionData": { "$ref": "GoogleCloudAiplatformV1beta1SchemaPromptSpecInteractionData", "description": "Data for interaction use case." }, "outputPrefixes": { "items": { "type": "string" }, "description": "Preamble: The output prefixes before each example output.", "type": "array" }, "appBuilderData": { "description": "Data for app builder use case.", "$ref": "GoogleCloudAiplatformV1beta1SchemaPromptSpecAppBuilderData" }, "context": { "description": "Preamble: The context of the prompt.", "$ref": "GoogleCloudAiplatformV1beta1Content" }, "predictionInputs": { "description": "Preamble: The input test data for prediction. Each PartList in this field represents one text-only input set for a single model request.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaPromptSpecPartList" } }, "inputPrefixes": { "description": "Preamble: The input prefixes before each example input.", "items": { "type": "string" }, "type": "array" } }, "type": "object", "description": "Prompt variation that stores preambles in separate fields.", "id": "GoogleCloudAiplatformV1beta1SchemaPromptSpecStructuredPrompt" }, "GoogleCloudAiplatformV1beta1BatchPredictionJobOutputConfig": { "id": "GoogleCloudAiplatformV1beta1BatchPredictionJobOutputConfig", "description": "Configures the output of BatchPredictionJob. See Model.supported_output_storage_formats for supported output formats, and how predictions are expressed via any of them.", "type": "object", "properties": { "bigqueryDestination": { "description": "The BigQuery project or dataset location where the output is to be written to. If project is provided, a new dataset is created with name `prediction__` where is made BigQuery-dataset-name compatible (for example, most special characters become underscores), and timestamp is in YYYY_MM_DDThh_mm_ss_sssZ \"based on ISO-8601\" format. In the dataset two tables will be created, `predictions`, and `errors`. If the Model has both instance and prediction schemata defined then the tables have columns as follows: The `predictions` table contains instances for which the prediction succeeded, it has columns as per a concatenation of the Model's instance and prediction schemata. The `errors` table contains rows for which the prediction has failed, it has instance columns, as per the instance schema, followed by a single \"errors\" column, which as values has google.rpc.Status represented as a STRUCT, and containing only `code` and `message`.", "$ref": "GoogleCloudAiplatformV1beta1BigQueryDestination" }, "gcsDestination": { "$ref": "GoogleCloudAiplatformV1beta1GcsDestination", "description": "The Cloud Storage location of the directory where the output is to be written to. In the given directory a new directory is created. Its name is `prediction--`, where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. Inside of it files `predictions_0001.`, `predictions_0002.`, ..., `predictions_N.` are created where `` depends on chosen predictions_format, and N may equal 0001 and depends on the total number of successfully predicted instances. If the Model has both instance and prediction schemata defined then each such file contains predictions as per the predictions_format. If prediction for any instance failed (partially or completely), then an additional `errors_0001.`, `errors_0002.`,..., `errors_N.` files are created (N depends on total number of failed predictions). These files contain the failed instances, as per their schema, followed by an additional `error` field which as value has google.rpc.Status containing only `code` and `message` fields." }, "vertexMultimodalDatasetDestination": { "description": "The details for a Vertex Multimodal Dataset that will be created for the output.", "$ref": "GoogleCloudAiplatformV1beta1VertexMultimodalDatasetDestination" }, "predictionsFormat": { "type": "string", "description": "Required. The format in which Vertex AI gives the predictions, must be one of the Model's supported_output_storage_formats." } } }, "GoogleCloudAiplatformV1beta1NotebookExecutionJobDataformRepositorySource": { "type": "object", "description": "The Dataform Repository containing the input notebook.", "properties": { "commitSha": { "description": "The commit SHA to read repository with. If unset, the file will be read at HEAD.", "type": "string" }, "dataformRepositoryResourceName": { "description": "The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1NotebookExecutionJobDataformRepositorySource" }, "GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricGenerationSpec": { "properties": { "modelConfig": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigAutoraterConfig", "description": "Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation." }, "promptTemplate": { "type": "string", "description": "Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements." }, "metricResourceName": { "type": "string", "description": "Optional. Resource name of the metric definition." }, "rubricTypeOntology": { "description": "Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.", "type": "array", "items": { "type": "string" } }, "rubricContentType": { "enumDescriptions": [ "The content type to generate is not specified.", "Generate rubrics based on properties.", "Generate rubrics in an NL question answer format.", "Generate rubrics in a unit test format." ], "type": "string", "enum": [ "RUBRIC_CONTENT_TYPE_UNSPECIFIED", "PROPERTY", "NL_QUESTION_ANSWER", "PYTHON_CODE_ASSERTION" ], "description": "Optional. The type of rubric content to be generated." } }, "type": "object", "description": "Specification for how rubrics should be generated.", "id": "GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricGenerationSpec" }, "GoogleCloudAiplatformV1beta1A2aTaskStatus": { "description": "Represents the status of an A2aTask.", "id": "GoogleCloudAiplatformV1beta1A2aTaskStatus", "properties": { "timestamp": { "type": "string", "description": "Output only. The time at which the state was set.", "format": "google-datetime", "readOnly": true }, "message": { "description": "Output only. The status message associated with the state.", "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1A2aTaskMessage" }, "state": { "readOnly": true, "type": "string", "enum": [ "STATE_UNSPECIFIED", "TASK_STATE_SUBMITTED", "TASK_STATE_WORKING", "TASK_STATE_COMPLETED", "TASK_STATE_FAILED", "TASK_STATE_CANCELED", "TASK_STATE_INPUT_REQUIRED", "TASK_STATE_REJECTED", "TASK_STATE_AUTH_REQUIRED" ], "enumDescriptions": [ "The task is in an unknown or indeterminate state.", "Indicates that a task has been successfully submitted and acknowledged.", "Indicates that a task is actively being processed by the agent.", "Indicates that a task has finished successfully. This is a terminal state.", "Indicates that a task has finished with an error. This is a terminal state.", "Indicates that a task was canceled before completion. This is a terminal state.", "Indicates that the agent requires additional user input to proceed. This is an interrupted state.", "Indicates that the agent has decided to not perform the task. This may be done during initial task creation or later once an agent has determined it can't or won't proceed. This is a terminal state.", "Indicates that authentication is required to proceed. This is an interrupted state." ], "description": "Output only. The current state of the task." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1FeatureViewFeatureRegistrySourceFeatureGroup": { "id": "GoogleCloudAiplatformV1beta1FeatureViewFeatureRegistrySourceFeatureGroup", "description": "Features belonging to a single feature group that will be synced to Online Store.", "type": "object", "properties": { "featureIds": { "description": "Required. Identifiers of features under the feature group.", "items": { "type": "string" }, "type": "array" }, "featureGroupId": { "type": "string", "description": "Required. Identifier of the feature group." } } }, "GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec": { "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec", "properties": { "secretEnv": { "items": { "$ref": "GoogleCloudAiplatformV1beta1SecretEnvVar" }, "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.", "type": "array" }, "agentServerMode": { "enum": [ "AGENT_SERVER_MODE_UNSPECIFIED", "STABLE", "EXPERIMENTAL" ], "enumDescriptions": [ "Unspecified agent server mode. Do not use.", "Stable agent server mode. This mode has everything stable and well-tested features agent engine offers.", "Experimental agent server mode. This mode contains experimental features." ], "type": "string", "description": "The agent server mode." }, "agentGatewayConfig": { "description": "Optional. Agent Gateway configuration for the Reasoning Engine deployment.", "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpecAgentGatewayConfig" }, "containerConcurrency": { "description": "Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.", "type": "integer", "format": "int32" }, "maxInstances": { "description": "Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100].", "format": "int32", "type": "integer" }, "resourceLimits": { "description": "Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are supported. Defaults to {\"cpu\": \"4\", \"memory\": \"4Gi\"}. * The only supported values for CPU are '1', '2', '4', '6' and '8'. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * The only supported values for memory are '1Gi', '2Gi', ... '32 Gi'. * For required cpu on different memory values, go to https://cloud.google.com/run/docs/configuring/memory-limits", "additionalProperties": { "type": "string" }, "type": "object" }, "minInstances": { "format": "int32", "type": "integer", "description": "Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 75]." }, "keepAliveProbe": { "description": "Optional. Specifies the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings.", "$ref": "GoogleCloudAiplatformV1beta1KeepAliveProbe" }, "env": { "items": { "$ref": "GoogleCloudAiplatformV1beta1EnvVar" }, "description": "Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.", "type": "array" }, "pscInterfaceConfig": { "$ref": "GoogleCloudAiplatformV1beta1PscInterfaceConfig", "description": "Optional. Configuration for PSC-I." } }, "description": "The specification of a Reasoning Engine deployment.", "type": "object" }, "GoogleCloudAiplatformV1beta1CompleteTrialRequest": { "description": "Request message for VizierService.CompleteTrial.", "id": "GoogleCloudAiplatformV1beta1CompleteTrialRequest", "type": "object", "properties": { "finalMeasurement": { "description": "Optional. If provided, it will be used as the completed Trial's final_measurement; Otherwise, the service will auto-select a previously reported measurement as the final-measurement", "$ref": "GoogleCloudAiplatformV1beta1Measurement" }, "infeasibleReason": { "description": "Optional. A human readable reason why the trial was infeasible. This should only be provided if `trial_infeasible` is true.", "type": "string" }, "trialInfeasible": { "type": "boolean", "description": "Optional. True if the Trial cannot be run with the given Parameter, and final_measurement will be ignored." } } }, "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentTemplatesResponse": { "description": "Response message for SandboxEnvironmentService.ListSandboxEnvironmentTemplates.", "id": "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentTemplatesResponse", "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "A token, which can be sent as ListSandboxEnvironmentTemplatesRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages." }, "sandboxEnvironmentTemplates": { "description": "The SandboxEnvironmentTemplates matching the request.", "items": { "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplate" }, "type": "array" } } }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation": { "properties": { "columnName": { "type": "string" }, "invalidValuesAllowed": { "type": "boolean", "description": "If invalid values is allowed, the training pipeline will create a boolean feature that indicated whether the value is valid. Otherwise, the training pipeline will discard the input row from trainining data." } }, "description": "Training pipeline will perform following transformation functions. * The value converted to float32. * The z_score of the value. * log(value+1) when the value is greater than or equal to 0. Otherwise, this transformation is not applied and the value is considered a missing value. * z_score of log(value+1) when the value is greater than or equal to 0. Otherwise, this transformation is not applied and the value is considered a missing value. * A boolean value that indicates whether the value is valid.", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation", "type": "object" }, "GenaiVertexV1beta1ContentStart": { "id": "GenaiVertexV1beta1ContentStart", "type": "object", "properties": { "content": { "$ref": "GenaiVertexV1beta1Content" }, "index": { "type": "integer", "format": "int32" } } }, "GoogleCloudAiplatformV1beta1SchemaVideoDatasetMetadata": { "description": "The metadata of Datasets that contain Video DataItems.", "type": "object", "properties": { "gcsBucket": { "description": "Google Cloud Storage Bucket name that contains the blob data of this Dataset.", "type": "string" }, "dataItemSchemaUri": { "type": "string", "description": "Points to a YAML file stored on Google Cloud Storage describing payload of the Video DataItems that belong to this Dataset." } }, "id": "GoogleCloudAiplatformV1beta1SchemaVideoDatasetMetadata" }, "GenaiVertexV1beta1GoogleMapsResultContent": { "description": "Google Maps result content.", "properties": { "result": { "items": { "$ref": "GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResult" }, "type": "array", "description": "Required. The results of the Google Maps." } }, "id": "GenaiVertexV1beta1GoogleMapsResultContent", "deprecated": true, "type": "object" }, "GoogleCloudAiplatformV1beta1GroundednessInstance": { "properties": { "context": { "description": "Required. Background information provided in context used to compare against the prediction.", "type": "string" }, "prediction": { "description": "Required. Output of the evaluated model.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1GroundednessInstance", "description": "Spec for groundedness instance.", "type": "object" }, "GoogleCloudAiplatformV1beta1FeatureOnlineStoreEmbeddingManagement": { "properties": { "enabled": { "type": "boolean", "description": "Optional. Immutable. Whether to enable embedding management in this FeatureOnlineStore. It's immutable after creation to ensure the FeatureOnlineStore availability." } }, "deprecated": true, "description": "Deprecated: This sub message is no longer needed anymore and embedding management is automatically enabled when specifying Optimized storage type. Contains settings for embedding management.", "id": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreEmbeddingManagement", "type": "object" }, "GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest": { "description": "Request message for FeaturestoreService.BatchCreateFeatures. Request message for FeatureRegistryService.BatchCreateFeatures.", "properties": { "requests": { "description": "Required. The request message specifying the Features to create. All Features must be created under the same parent EntityType / FeatureGroup. The `parent` field in each child request message can be omitted. If `parent` is set in a child request, then the value must match the `parent` value in this request message.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1CreateFeatureRequest" } } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest" }, "GoogleCloudAiplatformV1beta1BigQuerySource": { "description": "The BigQuery location for the input content.", "properties": { "inputUri": { "description": "Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1BigQuerySource", "type": "object" }, "GoogleCloudAiplatformV1beta1ContentMapContents": { "id": "GoogleCloudAiplatformV1beta1ContentMapContents", "properties": { "contents": { "description": "Optional. Repeated contents.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" }, "type": "array" } }, "description": "Repeated Content type.", "type": "object" }, "GoogleCloudAiplatformV1beta1PairwiseMetricResult": { "type": "object", "properties": { "pairwiseChoice": { "enum": [ "PAIRWISE_CHOICE_UNSPECIFIED", "BASELINE", "CANDIDATE", "TIE" ], "enumDescriptions": [ "Unspecified prediction choice.", "Baseline prediction wins", "Candidate prediction wins", "Winner cannot be determined" ], "description": "Output only. Pairwise metric choice.", "type": "string", "readOnly": true }, "customOutput": { "$ref": "GoogleCloudAiplatformV1beta1CustomOutput", "readOnly": true, "description": "Output only. Spec for custom output." }, "explanation": { "readOnly": true, "type": "string", "description": "Output only. Explanation for pairwise metric score." } }, "description": "Spec for pairwise metric result.", "id": "GoogleCloudAiplatformV1beta1PairwiseMetricResult" }, "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeatureFeatureValueAndTimestamp": { "type": "object", "description": "Feature value and timestamp.", "properties": { "value": { "description": "The feature value.", "$ref": "GoogleCloudAiplatformV1beta1FeatureValue" }, "timestamp": { "format": "google-datetime", "type": "string", "description": "The feature timestamp to store with this value. If not set, then the Feature Store server will generate a timestamp when it receives the write request." } }, "id": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeatureFeatureValueAndTimestamp" }, "GoogleCloudAiplatformV1beta1TrajectoryInOrderMatchResults": { "properties": { "trajectoryInOrderMatchMetricValues": { "description": "Output only. TrajectoryInOrderMatch metric values.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1TrajectoryInOrderMatchMetricValue" } } }, "description": "Results for TrajectoryInOrderMatch metric.", "type": "object", "id": "GoogleCloudAiplatformV1beta1TrajectoryInOrderMatchResults" }, "GoogleCloudAiplatformV1beta1GenerateMemoriesRequestDirectMemoriesSource": { "id": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequestDirectMemoriesSource", "type": "object", "description": "Defines a direct source of memories that should be uploaded to Memory Bank with consolidation.", "properties": { "directMemories": { "type": "array", "description": "Required. The direct memories to upload to Memory Bank. At most 5 direct memories are allowed per request.", "items": { "$ref": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequestDirectMemoriesSourceDirectMemory" } } } }, "GoogleCloudAiplatformV1beta1AppendA2ATaskRecordEventsResponse": { "properties": { "generation": { "type": "string", "description": "Task generation matching the last event", "format": "int64" } }, "description": "Response message for A2ATaskRecordService.AppendA2ATaskRecordEvents.", "type": "object", "id": "GoogleCloudAiplatformV1beta1AppendA2ATaskRecordEventsResponse" }, "GoogleCloudAiplatformV1beta1AppendEventResponse": { "type": "object", "properties": {}, "description": "Response message for SessionService.AppendEvent.", "id": "GoogleCloudAiplatformV1beta1AppendEventResponse" }, "GenaiVertexV1beta1DeleteInteractionResponse": { "description": "Response for InteractionService.DeleteInteraction.", "properties": {}, "type": "object", "id": "GenaiVertexV1beta1DeleteInteractionResponse" }, "GoogleRpcStatus": { "type": "object", "description": "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).", "id": "GoogleRpcStatus", "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32", "type": "integer" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" } }, "message": { "type": "string", "description": "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." } } }, "GoogleCloudAiplatformV1beta1SchemaMultimodalDatasetMetadataBigQuerySource": { "id": "GoogleCloudAiplatformV1beta1SchemaMultimodalDatasetMetadataBigQuerySource", "properties": { "uri": { "type": "string", "description": "The URI of a BigQuery table. e.g. bq://project.bqDataset.bqTable" } }, "description": "Specifies the BigQuery source.", "type": "object" }, "GoogleCloudAiplatformV1beta1RuntimeConfigCodeInterpreterRuntimeConfig": { "properties": { "fileOutputGcsBucket": { "type": "string", "description": "Optional. The Cloud Storage bucket for file output of this Extension. If specified, write all output files to the Cloud Storage bucket. Vertex Extension Custom Code Service Agent should be granted file writer to this bucket. If not specified, the file content will be output in response body." }, "fileInputGcsBucket": { "description": "Optional. The Cloud Storage bucket for file input of this Extension. If specified, support input from the Cloud Storage bucket. Vertex Extension Custom Code Service Agent should be granted file reader to this bucket. If not specified, the extension will only accept file contents from request body and reject Cloud Storage file inputs.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1RuntimeConfigCodeInterpreterRuntimeConfig", "type": "object" }, "GoogleCloudAiplatformV1beta1XmanagerInstance": { "description": "XmanagerInstance represents a managed Xmanager on Cloud deployment.", "type": "object", "id": "GoogleCloudAiplatformV1beta1XmanagerInstance", "properties": { "name": { "description": "Output only. Identifier. The resource name of the XmanagerInstance. Format: projects/{project}/locations/{location}/xmanagerInstances/{xmanager_instance}", "type": "string" }, "xprofConfig": { "$ref": "GoogleCloudAiplatformV1beta1XprofConfig", "description": "Optional. If set, the XmanagerInstance will be set up for managed XProf." }, "registeredClusters": { "description": "Output only. The resource names of the ModelDevelopmentClusters registered with this instance.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. Last update timestamp.", "readOnly": true }, "apiEndpoint": { "readOnly": true, "type": "string", "description": "Output only. gRPC API endpoint for Experiment State Server (ESS)." }, "network": { "type": "string", "description": "Required. Immutable. The VPC network in the consumer project. Format: projects/{project}/global/networks/{network}" }, "createTime": { "description": "Output only. Creation timestamp.", "format": "google-datetime", "readOnly": true, "type": "string" }, "subnetwork": { "description": "Required. Immutable. A subnet in `network`. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork}", "type": "string" }, "state": { "description": "Output only. The current state of the XmanagerInstance.", "enumDescriptions": [ "State is unspecified.", "Tenant infrastructure being created.", "Available for cluster registration and use.", "Deprovisioning is in progress.", "Provisioning or operation failed." ], "enum": [ "STATE_UNSPECIFIED", "STATE_PROVISIONING", "STATE_RUNNING", "STATE_DELETING", "STATE_ERROR" ], "readOnly": true, "type": "string" }, "uiEndpoint": { "type": "string", "readOnly": true, "description": "Output only. UI endpoint for Xmanager." } } }, "GoogleCloudAiplatformV1beta1SearchModelMonitoringAlertsResponse": { "properties": { "nextPageToken": { "type": "string", "description": "The page token that can be used by the next ModelMonitoringService.SearchModelMonitoringAlerts call." }, "totalNumberAlerts": { "type": "string", "description": "The total number of alerts retrieved by the requested objectives.", "format": "int64" }, "modelMonitoringAlerts": { "description": "Alerts retrieved for the requested objectives. Sorted by alert time descendingly.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringAlert" }, "type": "array" } }, "description": "Response message for ModelMonitoringService.SearchModelMonitoringAlerts.", "type": "object", "id": "GoogleCloudAiplatformV1beta1SearchModelMonitoringAlertsResponse" }, "GoogleCloudAiplatformV1beta1RagChunk": { "type": "object", "properties": { "chunkId": { "description": "The ID of the chunk.", "type": "string" }, "pageSpan": { "$ref": "GoogleCloudAiplatformV1beta1RagChunkPageSpan", "description": "If populated, represents where the chunk starts and ends in the document." }, "fileId": { "type": "string", "description": "The ID of the file that the chunk belongs to." }, "text": { "type": "string", "description": "The content of the chunk." } }, "id": "GoogleCloudAiplatformV1beta1RagChunk", "description": "A RagChunk includes the content of a chunk of a RagFile, and associated metadata." }, "GoogleCloudAiplatformV1beta1SingleReinforcementTuningRewardConfig": { "id": "GoogleCloudAiplatformV1beta1SingleReinforcementTuningRewardConfig", "type": "object", "properties": { "codeExecutionRewardScorer": { "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningCodeExecutionRewardScorer", "description": "ReinforcementTuningCodeExecutionRewardScorer is used to score parsed responses for code execution use cases." }, "parseResponseConfig": { "description": "Defines how to parse sample response. For example, given a sample response for evaluating the reward, users might want to extract the text only between `` and `` in the sample response, and keeps only the last one in case there are multiple such tags. To achieve such a purpose, they can define a regex `\".*(.*?)\"` using the ReinforcementTuningParseResponseConfig.ResponseParseType.REGEX_EXTRACT parse type.", "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningParseResponseConfig" }, "cloudRunRewardScorer": { "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningCloudRunRewardScorer", "description": "ReinforcementTuningCloudRunRewardScorer is used to score parsed responses by calling a Cloud Run service." }, "autoraterScorer": { "description": "ReinforcementTuningAutoraterScorer is used to score parsed responses based on score computed by an autorater.", "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorer" }, "stringMatchRewardScorer": { "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorer", "description": "ReinforcementTuningStringMatchRewardScorer is used to score parsed responses for simple string matching use cases against reference answers." }, "rewardName": { "description": "A unique reward name for identifying each single reinforcement tuning reward.", "type": "string" } }, "description": "SingleReinforcementTuningRewardConfig defines a single reward function configuration for RL tuning. Each reward calculation/evaluation consists of two stages: 1. Stage 1: Parses the part of information important from sample response via regex extract, or simply takes the sample response unmodified. 2. Stage 2: Calls the configured reward scorer to compute the reward." }, "GoogleCloudAiplatformV1beta1EvaluationItem": { "properties": { "gcsUri": { "type": "string", "description": "The Cloud Storage object where the request or response is stored." }, "labels": { "type": "object", "description": "Optional. Labels for the EvaluationItem.", "additionalProperties": { "type": "string" } }, "createTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp when this item was created." }, "evaluationResponse": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationResult", "readOnly": true, "description": "Output only. The response from evaluation." }, "error": { "readOnly": true, "description": "Output only. Error for the evaluation item.", "$ref": "GoogleRpcStatus" }, "evaluationRequest": { "description": "The request to evaluate.", "$ref": "GoogleCloudAiplatformV1beta1EvaluationRequest" }, "displayName": { "description": "Required. The display name of the EvaluationItem.", "type": "string" }, "metadata": { "description": "Optional. Metadata for the EvaluationItem.", "type": "any" }, "name": { "type": "string", "description": "Identifier. The resource name of the EvaluationItem. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`" }, "evaluationItemType": { "enum": [ "EVALUATION_ITEM_TYPE_UNSPECIFIED", "REQUEST", "RESULT" ], "enumDescriptions": [ "The default value. This value is unused.", "The EvaluationItem is a request to evaluate.", "The EvaluationItem is the result of evaluation." ], "type": "string", "description": "Required. The type of the EvaluationItem." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1EvaluationItem", "description": "EvaluationItem is a single evaluation request or result. The content of an EvaluationItem is immutable - it cannot be updated once created. EvaluationItems can be deleted when no longer needed." }, "GoogleTypeDate": { "properties": { "day": { "description": "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.", "type": "integer", "format": "int32" }, "year": { "type": "integer", "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "format": "int32" }, "month": { "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "format": "int32", "type": "integer" } }, "description": "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", "type": "object", "id": "GoogleTypeDate" }, "GoogleCloudAiplatformV1beta1MemoryGenerationTriggerConfigGenerationTriggerRule": { "description": "Represents the active rule that determines when to flush the buffer.", "properties": { "eventCount": { "format": "int32", "type": "integer", "description": "Optional. Specifies to trigger generation when the event count reaches this limit." }, "idleDuration": { "description": "Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity.", "type": "string", "format": "google-duration" }, "overlapEventCount": { "description": "Optional. Re-include the last N already-processed events in the next window.", "type": "integer", "format": "int32" }, "fixedInterval": { "type": "string", "description": "Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity.", "format": "google-duration" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1MemoryGenerationTriggerConfigGenerationTriggerRule" }, "GenaiVertexV1beta1GoogleSearch": { "type": "object", "id": "GenaiVertexV1beta1GoogleSearch", "properties": { "searchTypes": { "type": "array", "description": "The types of search grounding to enable.", "items": { "type": "string", "enum": [ "SEARCH_TYPE_UNSPECIFIED", "SEARCH_TYPE_WEB_SEARCH", "SEARCH_TYPE_IMAGE_SEARCH", "SEARCH_TYPE_ENTERPRISE_WEB_SEARCH" ], "enumDescriptions": [ "Unspecified search type. This value should not be used.", "Setting this field enables web search. Only text results are returned.", "Setting this field enables image search. Image bytes are returned.", "Setting this field enables enterprise web search." ] } } }, "description": "A tool that can be used by the model to search Google." }, "GoogleCloudAiplatformV1beta1SchemaPredictInstanceTextClassificationPredictionInstance": { "type": "object", "description": "Prediction input format for Text Classification.", "id": "GoogleCloudAiplatformV1beta1SchemaPredictInstanceTextClassificationPredictionInstance", "properties": { "content": { "type": "string", "description": "The text snippet to make the predictions on." }, "mimeType": { "description": "The MIME type of the text snippet. The supported MIME types are listed below. - text/plain", "type": "string" } } }, "GoogleCloudAiplatformV1beta1RagManagedDbConfigUnprovisioned": { "type": "object", "id": "GoogleCloudAiplatformV1beta1RagManagedDbConfigUnprovisioned", "description": "Disables the RAG Engine service and deletes all your data held within this service. This will halt the billing of the service. NOTE: Once deleted the data cannot be recovered. To start using RAG Engine again, you will need to update the tier by calling the UpdateRagEngineConfig API.", "properties": {} }, "GoogleCloudAiplatformV1beta1SyntheticExample": { "description": "A single instance of generated synthetic data. Each example is made up of one or more named fields, as defined in `OutputFieldSpec`. These examples are used as few-shot examples to show the model what you want (in `GenerateSyntheticDataRequest.examples`) and to return generated examples in the response (in `GenerateSyntheticDataResponse.synthetic_examples`).", "id": "GoogleCloudAiplatformV1beta1SyntheticExample", "type": "object", "properties": { "fields": { "description": "Required. A list of fields that constitute an example.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1SyntheticField" } } } }, "GoogleCloudAiplatformV1beta1MemoryStructuredContent": { "type": "object", "description": "Represents the structured value of the memory.", "id": "GoogleCloudAiplatformV1beta1MemoryStructuredContent", "properties": { "data": { "type": "object", "description": "Required. Represents the structured value of the memory.", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "schemaId": { "type": "string", "description": "Required. Represents the schema ID for which this structured memory belongs to." } } }, "GoogleCloudAiplatformV1beta1AssignNotebookRuntimeRequest": { "type": "object", "id": "GoogleCloudAiplatformV1beta1AssignNotebookRuntimeRequest", "description": "Request message for NotebookService.AssignNotebookRuntime.", "properties": { "notebookRuntime": { "$ref": "GoogleCloudAiplatformV1beta1NotebookRuntime", "description": "Required. Provide runtime specific information (e.g. runtime owner, notebook id) used for NotebookRuntime assignment." }, "notebookRuntimeId": { "description": "Optional. User specified ID for the notebook runtime.", "type": "string" }, "notebookRuntimeTemplate": { "type": "string", "description": "Required. The resource name of the NotebookRuntimeTemplate based on which a NotebookRuntime will be assigned (reuse or create a new one)." } } }, "GoogleCloudAiplatformV1beta1CustomCodeExecutionResult": { "id": "GoogleCloudAiplatformV1beta1CustomCodeExecutionResult", "type": "object", "properties": { "score": { "format": "float", "readOnly": true, "description": "Output only. Custom code execution score.", "type": "number" } }, "description": "Result for custom code execution metric." }, "GoogleCloudAiplatformV1beta1SchemaPromptInstanceVariableValue": { "description": "The value of a variable in prompt.", "properties": { "partList": { "description": "The parts of the variable value.", "$ref": "GoogleCloudAiplatformV1beta1SchemaPromptSpecPartList" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaPromptInstanceVariableValue" }, "GoogleCloudAiplatformV1beta1StopNotebookRuntimeRequest": { "id": "GoogleCloudAiplatformV1beta1StopNotebookRuntimeRequest", "type": "object", "properties": {}, "description": "Request message for NotebookService.StopNotebookRuntime." }, "GoogleCloudAiplatformV1beta1ModelMonitoringAnomalyTabularAnomaly": { "description": "Tabular anomaly details.", "type": "object", "properties": { "condition": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringAlertCondition", "description": "The alert condition associated with this anomaly." }, "anomalyUri": { "description": "Additional anomaly information. e.g. Google Cloud Storage uri.", "type": "string" }, "triggerTime": { "type": "string", "description": "The time the anomaly was triggered.", "format": "google-datetime" }, "summary": { "description": "Overview of this anomaly.", "type": "string" }, "anomaly": { "type": "any", "description": "Anomaly body." } }, "id": "GoogleCloudAiplatformV1beta1ModelMonitoringAnomalyTabularAnomaly" }, "GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig": { "type": "object", "description": "Configuration for a prebuilt voice.", "id": "GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig", "properties": { "voiceName": { "type": "string", "description": "The name of the prebuilt voice to use." } } }, "GoogleCloudAiplatformV1beta1MetricxSpec": { "description": "Spec for MetricX metric.", "properties": { "version": { "description": "Required. Which version to use for evaluation.", "enum": [ "METRICX_VERSION_UNSPECIFIED", "METRICX_24_REF", "METRICX_24_SRC", "METRICX_24_SRC_REF" ], "enumDescriptions": [ "MetricX version unspecified.", "MetricX 2024 (2.6) for translation + reference (reference-based).", "MetricX 2024 (2.6) for translation + source (QE).", "MetricX 2024 (2.6) for translation + source + reference (source-reference-combined)." ], "type": "string" }, "targetLanguage": { "description": "Optional. Target language in BCP-47 format. Covers both prediction and reference.", "type": "string" }, "sourceLanguage": { "type": "string", "description": "Optional. Source language in BCP-47 format." } }, "id": "GoogleCloudAiplatformV1beta1MetricxSpec", "type": "object" }, "GoogleCloudAiplatformV1beta1FeaturestoreOnlineServingConfigScaling": { "description": "Online serving scaling configuration. If min_node_count and max_node_count are set to the same value, the cluster will be configured with the fixed number of node (no auto-scaling).", "properties": { "minNodeCount": { "type": "integer", "format": "int32", "description": "Required. The minimum number of nodes to scale down to. Must be greater than or equal to 1." }, "maxNodeCount": { "type": "integer", "format": "int32", "description": "The maximum number of nodes to scale up to. Must be greater than min_node_count, and less than or equal to 10 times of 'min_node_count'." }, "cpuUtilizationTarget": { "type": "integer", "description": "Optional. The cpu utilization that the Autoscaler should be trying to achieve. This number is on a scale from 0 (no utilization) to 100 (total utilization), and is limited between 10 and 80. When a cluster's CPU utilization exceeds the target that you have set, Bigtable immediately adds nodes to the cluster. When CPU utilization is substantially lower than the target, Bigtable removes nodes. If not set or set to 0, default to 50.", "format": "int32" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1FeaturestoreOnlineServingConfigScaling" }, "GoogleCloudAiplatformV1beta1QuestionAnsweringRelevanceInstance": { "id": "GoogleCloudAiplatformV1beta1QuestionAnsweringRelevanceInstance", "properties": { "reference": { "description": "Optional. Ground truth used to compare against the prediction.", "type": "string" }, "context": { "type": "string", "description": "Optional. Text provided as context to answer the question." }, "instruction": { "description": "Required. The question asked and other instruction in the inference prompt.", "type": "string" }, "prediction": { "type": "string", "description": "Required. Output of the evaluated model." } }, "type": "object", "description": "Spec for question answering relevance instance." }, "GoogleCloudAiplatformV1beta1A2aTaskEventData": { "type": "object", "description": "The data describing the change carried by an A2aTaskEvent. Exactly one of the following changes is set per event.", "properties": { "historyAppend": { "$ref": "GoogleCloudAiplatformV1beta1A2aTaskHistoryAppend", "description": "Optional. A new message appended to the task history." }, "metadataChange": { "description": "Optional. A change to the task-level metadata.", "$ref": "GoogleCloudAiplatformV1beta1A2aTaskMetadataChange" }, "statusUpdate": { "description": "Optional. An update to the task's state and status message.", "$ref": "GoogleCloudAiplatformV1beta1A2aTaskStatusUpdate" }, "artifactChange": { "description": "Optional. A change to one of the task's artifacts.", "$ref": "GoogleCloudAiplatformV1beta1A2aTaskArtifactChange" } }, "id": "GoogleCloudAiplatformV1beta1A2aTaskEventData" }, "GoogleCloudAiplatformV1beta1PurgeExecutionsMetadata": { "type": "object", "id": "GoogleCloudAiplatformV1beta1PurgeExecutionsMetadata", "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "Operation metadata for purging Executions." } }, "description": "Details of operations that perform MetadataService.PurgeExecutions." }, "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsVideoActionMetrics": { "properties": { "meanAveragePrecision": { "type": "number", "description": "The mean average precision.", "format": "float" }, "precisionWindowLength": { "format": "google-duration", "type": "string", "description": "This VideoActionMetrics is calculated based on this prediction window length. If the predicted action's timestamp is inside the time window whose center is the ground truth action's timestamp with this specific length, the prediction result is treated as a true positive." }, "confidenceMetrics": { "description": "Metrics for each label-match confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics" } } }, "description": "The Evaluation metrics given a specific precision_window_length.", "id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsVideoActionMetrics", "type": "object" }, "GoogleCloudAiplatformV1beta1UploadModelResponse": { "id": "GoogleCloudAiplatformV1beta1UploadModelResponse", "type": "object", "properties": { "modelVersionId": { "type": "string", "readOnly": true, "description": "Output only. The version ID of the model that is uploaded." }, "model": { "description": "The name of the uploaded Model resource. Format: `projects/{project}/locations/{location}/models/{model}`", "type": "string" } }, "description": "Response message of ModelService.UploadModel operation." }, "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsVideoActionMetricsConfidenceMetrics", "description": "Metrics for a single confidence threshold.", "properties": { "confidenceThreshold": { "type": "number", "format": "float", "description": "Output only. The confidence threshold value used to compute the metrics." }, "f1Score": { "type": "number", "description": "Output only. The harmonic mean of recall and precision.", "format": "float" }, "precision": { "format": "float", "type": "number", "description": "Output only. Precision for the given confidence threshold." }, "recall": { "type": "number", "description": "Output only. Recall for the given confidence threshold.", "format": "float" } } }, "GoogleTypeExpr": { "id": "GoogleTypeExpr", "properties": { "location": { "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", "type": "string" }, "title": { "type": "string", "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression." }, "expression": { "description": "Textual representation of an expression in Common Expression Language syntax.", "type": "string" }, "description": { "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", "type": "string" } }, "type": "object", "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information." }, "GoogleCloudAiplatformV1beta1CreateIndexOperationMetadata": { "id": "GoogleCloudAiplatformV1beta1CreateIndexOperationMetadata", "description": "Runtime operation information for IndexService.CreateIndex.", "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "The operation generic information." }, "nearestNeighborSearchOperationMetadata": { "description": "The operation metadata with regard to Matching Engine Index operation.", "$ref": "GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadata" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1OutputInfo": { "properties": { "gcsOutputDirectory": { "description": "Output only. The full path of the Cloud Storage directory created, into which the evaluation results and aggregation results are written.", "readOnly": true, "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1OutputInfo", "description": "Describes the info for output of EvaluationService." }, "CloudAiLargeModelsVisionGenerateVideoResponseVideo": { "properties": { "bytesBase64Encoded": { "description": "Base64 encoded bytes string representing the video.", "type": "string" }, "experimentsMetadata": { "description": "Optional metadata returned from experimental requests. Likely only includes the rewritten prompt chunks.", "$ref": "CloudAiLargeModelsVisionGenerateVideoExperiments" }, "mimeType": { "description": "The MIME type of the content of the video. - video/mp4", "type": "string" }, "gcsUri": { "description": "Cloud Storage URI where the generated video is written.", "type": "string" } }, "id": "CloudAiLargeModelsVisionGenerateVideoResponseVideo", "type": "object" }, "GoogleCloudAiplatformV1beta1RetrieveProfilesRequest": { "description": "Request message for MemoryBankService.RetrieveProfiles.", "type": "object", "properties": { "scope": { "description": "Required. The scope of the profiles to retrieve.", "additionalProperties": { "type": "string" }, "type": "object" } }, "id": "GoogleCloudAiplatformV1beta1RetrieveProfilesRequest" }, "GenaiVertexV1beta1UrlContext": { "id": "GenaiVertexV1beta1UrlContext", "description": "A tool that can be used by the model to fetch URL context.", "type": "object", "properties": {} }, "GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfig": { "description": "Deprecated. Use IndexConfig instead.", "properties": { "embeddingColumn": { "type": "string", "description": "Optional. Column of embedding. This column contains the source data to create index for vector search. embedding_column must be set when using vector search." }, "distanceMeasureType": { "enum": [ "DISTANCE_MEASURE_TYPE_UNSPECIFIED", "SQUARED_L2_DISTANCE", "COSINE_DISTANCE", "DOT_PRODUCT_DISTANCE" ], "type": "string", "enumDescriptions": [ "Should not be set.", "Euclidean (L_2) Distance.", "Cosine Distance. Defined as 1 - cosine similarity. We strongly suggest using DOT_PRODUCT_DISTANCE + UNIT_L2_NORM instead of COSINE distance. Our algorithms have been more optimized for DOT_PRODUCT distance which, when combined with UNIT_L2_NORM, is mathematically equivalent to COSINE distance and results in the same ranking.", "Dot Product Distance. Defined as a negative of the dot product." ], "description": "Optional. The distance measure used in nearest neighbor search." }, "bruteForceConfig": { "description": "Optional. Configuration options for using brute force search, which simply implements the standard linear search in the database for each query. It is primarily meant for benchmarking and to generate the ground truth for approximate search.", "$ref": "GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfigBruteForceConfig" }, "crowdingColumn": { "type": "string", "description": "Optional. Column of crowding. This column contains crowding attribute which is a constraint on a neighbor list produced by FeatureOnlineStoreService.SearchNearestEntities to diversify search results. If NearestNeighborQuery.per_crowding_attribute_neighbor_count is set to K in SearchNearestEntitiesRequest, it's guaranteed that no more than K entities of the same crowding attribute are returned in the response." }, "treeAhConfig": { "description": "Optional. Configuration options for the tree-AH algorithm (Shallow tree + Asymmetric Hashing). Please refer to this paper for more details: https://arxiv.org/abs/1908.10396", "$ref": "GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfigTreeAHConfig" }, "embeddingDimension": { "type": "integer", "format": "int32", "description": "Optional. The number of dimensions of the input embedding." }, "filterColumns": { "type": "array", "items": { "type": "string" }, "description": "Optional. Columns of features that're used to filter vector search results." } }, "deprecated": true, "id": "GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfig", "type": "object" }, "GoogleCloudAiplatformV1beta1ExternalApi": { "description": "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.", "properties": { "apiSpec": { "description": "The API spec that the external API implements.", "type": "string", "enumDescriptions": [ "Unspecified API spec. This value should not be used.", "Simple search API spec.", "Elastic search API spec." ], "enum": [ "API_SPEC_UNSPECIFIED", "SIMPLE_SEARCH", "ELASTIC_SEARCH" ] }, "elasticSearchParams": { "description": "Parameters for the elastic search API.", "$ref": "GoogleCloudAiplatformV1beta1ExternalApiElasticSearchParams" }, "apiAuth": { "deprecated": true, "description": "The authentication config to access the API. Deprecated. Please use auth_config instead.", "$ref": "GoogleCloudAiplatformV1beta1ApiAuth" }, "simpleSearchParams": { "$ref": "GoogleCloudAiplatformV1beta1ExternalApiSimpleSearchParams", "description": "Parameters for the simple search API." }, "authConfig": { "$ref": "GoogleCloudAiplatformV1beta1AuthConfig", "description": "The authentication config to access the API." }, "endpoint": { "description": "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", "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ExternalApi" }, "GoogleCloudAiplatformV1beta1BatchCreateTensorboardTimeSeriesResponse": { "properties": { "tensorboardTimeSeries": { "type": "array", "description": "The created TensorboardTimeSeries.", "items": { "$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" } } }, "description": "Response message for TensorboardService.BatchCreateTensorboardTimeSeries.", "type": "object", "id": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardTimeSeriesResponse" }, "GenaiVertexV1beta1ThoughtSignatureDelta": { "properties": { "signature": { "type": "string", "format": "byte", "description": "Signature to match the backend source to be part of the generation." } }, "id": "GenaiVertexV1beta1ThoughtSignatureDelta", "type": "object" }, "GoogleCloudAiplatformV1beta1ResourcePool": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ResourcePool", "description": "Represents the spec of a group of resources of the same type, for example machine type, disk, and accelerators, in a PersistentResource.", "properties": { "id": { "description": "Immutable. The unique ID in a PersistentResource for referring to this resource pool. User can specify it if necessary. Otherwise, it's generated automatically.", "type": "string" }, "machineSpec": { "$ref": "GoogleCloudAiplatformV1beta1MachineSpec", "description": "Required. Immutable. The specification of a single machine." }, "autoscalingSpec": { "description": "Optional. Optional spec to configure GKE or Ray-on-Vertex autoscaling", "$ref": "GoogleCloudAiplatformV1beta1ResourcePoolAutoscalingSpec" }, "usedReplicaCount": { "type": "string", "readOnly": true, "description": "Output only. The number of machines currently in use by training jobs for this resource pool. Will replace idle_replica_count.", "format": "int64" }, "replicaCount": { "format": "int64", "type": "string", "description": "Optional. The total number of machines to use for this resource pool." }, "diskSpec": { "description": "Optional. Disk spec for the machine in this node pool.", "$ref": "GoogleCloudAiplatformV1beta1DiskSpec" } } }, "GoogleCloudAiplatformV1beta1PSCAutomationConfig": { "type": "object", "id": "GoogleCloudAiplatformV1beta1PSCAutomationConfig", "description": "PSC config that is used to automatically create PSC endpoints in the user projects.", "properties": { "state": { "description": "Output only. The state of the PSC service automation.", "readOnly": true, "type": "string", "enumDescriptions": [ "Should not be used.", "The PSC service automation is successful.", "The PSC service automation has failed." ], "enum": [ "PSC_AUTOMATION_STATE_UNSPECIFIED", "PSC_AUTOMATION_STATE_SUCCESSFUL", "PSC_AUTOMATION_STATE_FAILED" ] }, "projectId": { "type": "string", "description": "Required. Project id used to create forwarding rule." }, "errorMessage": { "readOnly": true, "description": "Output only. Error message if the PSC service automation failed.", "type": "string" }, "network": { "type": "string", "description": "Required. The full name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/get): `projects/{project}/global/networks/{network}`." }, "forwardingRule": { "description": "Output only. Forwarding rule created by the PSC service automation.", "type": "string", "readOnly": true }, "ipAddress": { "description": "Output only. IP address rule created by the PSC service automation.", "readOnly": true, "type": "string" } } }, "GoogleCloudAiplatformV1beta1Presets": { "type": "object", "description": "Preset configuration for example-based explanations", "properties": { "query": { "description": "Preset option controlling parameters for speed-precision trade-off when querying for examples. If omitted, defaults to `PRECISE`.", "enumDescriptions": [ "More precise neighbors as a trade-off against slower response.", "Faster response as a trade-off against less precise neighbors." ], "type": "string", "enum": [ "PRECISE", "FAST" ] }, "modality": { "description": "The modality of the uploaded model, which automatically configures the distance measurement and feature normalization for the underlying example index and queries. If your model does not precisely fit one of these types, it is okay to choose the closest type.", "enumDescriptions": [ "Should not be set. Added as a recommended best practice for enums", "IMAGE modality", "TEXT modality", "TABULAR modality" ], "enum": [ "MODALITY_UNSPECIFIED", "IMAGE", "TEXT", "TABULAR" ], "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1Presets" }, "GoogleCloudAiplatformV1beta1EvaluationPrompt": { "id": "GoogleCloudAiplatformV1beta1EvaluationPrompt", "type": "object", "description": "Prompt to be evaluated. This can represent a single-turn prompt or a multi-turn conversation for agent evaluations.", "properties": { "userScenario": { "description": "Optional. The generated user scenario used to drive multi-turn agent running results.", "$ref": "GoogleCloudAiplatformV1beta1EvaluationPromptUserScenario" }, "value": { "description": "Fields and values that can be used to populate the prompt template.", "type": "any" }, "text": { "description": "Text prompt.", "type": "string" }, "promptTemplateData": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationPromptPromptTemplateData", "description": "Prompt template data." }, "agentData": { "description": "Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This serves as the input context for agent scraping.", "$ref": "GoogleCloudAiplatformV1beta1AgentData" } } }, "GoogleCloudAiplatformV1beta1AuthorizeSandboxEnvironmentAccessRequest": { "description": "Request message for SandboxEnvironmentExecutionService.AuthorizeSandboxEnvironmentAccess.", "type": "object", "properties": {}, "id": "GoogleCloudAiplatformV1beta1AuthorizeSandboxEnvironmentAccessRequest" }, "GoogleCloudAiplatformV1beta1ToolCallValidSpec": { "description": "Spec for tool call valid metric.", "type": "object", "properties": {}, "id": "GoogleCloudAiplatformV1beta1ToolCallValidSpec" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecasting": { "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecasting", "type": "object", "description": "A TrainingJob that trains and uploads an AutoML Forecasting Model.", "properties": { "inputs": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputs", "description": "The input parameters of this TrainingJob." }, "metadata": { "description": "The metadata information.", "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingMetadata" } } }, "GoogleCloudAiplatformV1beta1DataLabelingJob": { "type": "object", "properties": { "datasets": { "description": "Required. Dataset resource names. Right now we only support labeling from a single Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", "items": { "type": "string" }, "type": "array" }, "inputs": { "type": "any", "description": "Required. Input config parameters for the DataLabelingJob." }, "name": { "description": "Output only. Resource name of the DataLabelingJob.", "type": "string", "readOnly": true }, "labelingProgress": { "format": "int32", "readOnly": true, "type": "integer", "description": "Output only. Current labeling job progress percentage scaled in interval [0, 100], indicating the percentage of DataItems that has been finished." }, "updateTime": { "description": "Output only. Timestamp when this DataLabelingJob was updated most recently.", "readOnly": true, "format": "google-datetime", "type": "string" }, "currentSpend": { "readOnly": true, "$ref": "GoogleTypeMoney", "description": "Output only. Estimated cost(in US dollars) that the DataLabelingJob has incurred to date." }, "activeLearningConfig": { "description": "Parameters that configure the active learning pipeline. Active learning will label the data incrementally via several iterations. For every iteration, it will select a batch of data based on the sampling strategy.", "$ref": "GoogleCloudAiplatformV1beta1ActiveLearningConfig" }, "inputsSchemaUri": { "description": "Required. Points to a YAML file stored on Google Cloud Storage describing the config for a specific type of DataLabelingJob. The schema files that can be used here are found in the https://storage.googleapis.com/google-cloud-aiplatform bucket in the /schema/datalabelingjob/inputs/ folder.", "type": "string" }, "state": { "enum": [ "JOB_STATE_UNSPECIFIED", "JOB_STATE_QUEUED", "JOB_STATE_PENDING", "JOB_STATE_RUNNING", "JOB_STATE_SUCCEEDED", "JOB_STATE_FAILED", "JOB_STATE_CANCELLING", "JOB_STATE_CANCELLED", "JOB_STATE_PAUSED", "JOB_STATE_EXPIRED", "JOB_STATE_UPDATING", "JOB_STATE_PARTIALLY_SUCCEEDED" ], "readOnly": true, "enumDescriptions": [ "The job state is unspecified.", "The job has been just created or resumed and processing has not yet begun.", "The service is preparing to run the job.", "The job is in progress.", "The job completed successfully.", "The job failed.", "The job is being cancelled. From this state the job may only go to either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.", "The job has been cancelled.", "The job has been stopped, and can be resumed.", "The job has expired.", "The job is being updated. Only jobs in the `RUNNING` state can be updated. After updating, the job goes back to the `RUNNING` state.", "The job is partially succeeded, some results may be missing due to errors." ], "description": "Output only. The detailed state of the job.", "type": "string" }, "labelerCount": { "type": "integer", "format": "int32", "description": "Required. Number of labelers to work on each DataItem." }, "displayName": { "description": "Required. The user-defined name of the DataLabelingJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. Display name of a DataLabelingJob.", "type": "string" }, "instructionUri": { "description": "Required. The Google Cloud Storage location of the instruction pdf. This pdf is shared with labelers, and provides detailed description on how to label DataItems in Datasets.", "type": "string" }, "encryptionSpec": { "description": "Customer-managed encryption key spec for a DataLabelingJob. If set, this DataLabelingJob will be secured by this key. Note: Annotations created in the DataLabelingJob are associated with the EncryptionSpec of the Dataset they are exported to.", "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec" }, "error": { "description": "Output only. DataLabelingJob errors. It is only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.", "$ref": "GoogleRpcStatus", "readOnly": true }, "annotationLabels": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Labels to assign to annotations generated by this DataLabelingJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable." }, "labels": { "additionalProperties": { "type": "string" }, "type": "object", "description": "The labels with user-defined metadata to organize your DataLabelingJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable. Following system labels exist for each DataLabelingJob: * \"aiplatform.googleapis.com/schema\": output only, its value is the inputs_schema's title." }, "specialistPools": { "items": { "type": "string" }, "type": "array", "description": "The SpecialistPools' resource names associated with this job." }, "createTime": { "description": "Output only. Timestamp when this DataLabelingJob was created.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "description": "DataLabelingJob is used to trigger a human labeling job on unlabeled data from the following Dataset:", "id": "GoogleCloudAiplatformV1beta1DataLabelingJob" }, "GoogleCloudAiplatformV1beta1SchemaPredictPredictionImageSegmentationPredictionResult": { "properties": { "categoryMask": { "type": "string", "description": "A PNG image where each pixel in the mask represents the category in which the pixel in the original image was predicted to belong to. The size of this image will be the same as the original image. The mapping between the AnntoationSpec and the color can be found in model's metadata. The model will choose the most likely category and if none of the categories reach the confidence threshold, the pixel will be marked as background." }, "confidenceMask": { "description": "A one channel image which is encoded as an 8bit lossless PNG. The size of the image will be the same as the original image. For a specific pixel, darker color means less confidence in correctness of the cateogry in the categoryMask for the corresponding pixel. Black means no confidence and white means complete confidence.", "type": "string" } }, "type": "object", "description": "Prediction output format for Image Segmentation.", "id": "GoogleCloudAiplatformV1beta1SchemaPredictPredictionImageSegmentationPredictionResult" }, "GoogleCloudAiplatformV1beta1QuestionAnsweringQualitySpec": { "description": "Spec for question answering quality score metric.", "id": "GoogleCloudAiplatformV1beta1QuestionAnsweringQualitySpec", "properties": { "version": { "format": "int32", "description": "Optional. Which version to use for evaluation.", "type": "integer" }, "useReference": { "description": "Optional. Whether to use instance.reference to compute question answering quality.", "type": "boolean" } }, "type": "object" }, "GenaiVertexV1beta1GoogleMapsCallContentGoogleMapsCallArguments": { "description": "The arguments to pass to the Google Maps tool.", "type": "object", "id": "GenaiVertexV1beta1GoogleMapsCallContentGoogleMapsCallArguments", "properties": { "queries": { "items": { "type": "string" }, "description": "The queries to be executed.", "type": "array" } } }, "GenaiVertexV1beta1InteractionCompletedSseEvent": { "id": "GenaiVertexV1beta1InteractionCompletedSseEvent", "type": "object", "properties": { "interaction": { "$ref": "GenaiVertexV1beta1Interaction", "description": "Required. The completed interaction with empty outputs to reduce the payload size. Use the preceding ContentDelta events for the actual output." } } }, "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfig": { "description": "Represents configuration for organizing natural language memories for a particular scope.", "id": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfig", "properties": { "generateMemoriesExamples": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExample" }, "description": "Optional. Provides examples of how to generate memories for a particular scope." }, "enableThirdPersonMemories": { "description": "Optional. Indicates whether the memories will be generated in the third person (i.e. \"The user generates memories with Memory Bank.\"). By default, the memories will be generated in the first person (i.e. \"I generate memories with Memory Bank.\")", "type": "boolean" }, "memoryTopics": { "type": "array", "description": "Optional. Represents topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used.", "items": { "$ref": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigMemoryTopic" } }, "consolidationConfig": { "description": "Optional. Represents configuration for customizing how memories are consolidated together.", "$ref": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigConsolidationConfig" }, "scopeKeys": { "description": "Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank.", "type": "array", "items": { "type": "string" } }, "disableNaturalLanguageMemories": { "type": "boolean", "description": "Optional. Indicates whether natural language memory generation should be disabled for all requests. By default, natural language memory generation is enabled. Set this to `true` when you only want to generate structured memories." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1SyncFeatureViewResponse": { "properties": { "featureViewSync": { "description": "Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`", "type": "string" } }, "description": "Response message for FeatureOnlineStoreAdminService.SyncFeatureView.", "id": "GoogleCloudAiplatformV1beta1SyncFeatureViewResponse", "type": "object" }, "GoogleCloudAiplatformV1beta1RetrieveProfilesResponse": { "id": "GoogleCloudAiplatformV1beta1RetrieveProfilesResponse", "type": "object", "properties": { "profiles": { "type": "object", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1MemoryProfile" }, "description": "The retrieved structured profiles, which match the schemas under the requested scope. The key is the ID of the schema that the profile is linked with, which corresponds to the `schema_id` defined inside the `SchemaConfig`, under `StructuredMemoryCustomizationConfig`." } }, "description": "Response message for MemoryBankService.RetrieveProfiles." }, "GoogleCloudAiplatformV1beta1RagRetrievalConfigRanking": { "properties": { "rankService": { "$ref": "GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingRankService", "description": "Optional. Config for Rank Service." }, "llmRanker": { "description": "Optional. Config for LlmRanker.", "$ref": "GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingLlmRanker" } }, "id": "GoogleCloudAiplatformV1beta1RagRetrievalConfigRanking", "type": "object", "description": "Config for ranking and reranking." }, "GoogleCloudAiplatformV1beta1ToolCodeExecution": { "description": "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.", "id": "GoogleCloudAiplatformV1beta1ToolCodeExecution", "properties": {}, "type": "object" }, "GoogleCloudAiplatformV1beta1TrajectoryInOrderMatchInstance": { "description": "Spec for TrajectoryInOrderMatch instance.", "type": "object", "properties": { "predictedTrajectory": { "$ref": "GoogleCloudAiplatformV1beta1Trajectory", "description": "Required. Spec for predicted tool call trajectory." }, "referenceTrajectory": { "description": "Required. Spec for reference tool call trajectory.", "$ref": "GoogleCloudAiplatformV1beta1Trajectory" } }, "id": "GoogleCloudAiplatformV1beta1TrajectoryInOrderMatchInstance" }, "GoogleCloudAiplatformV1beta1SafetySpec": { "description": "Spec for safety metric.", "type": "object", "properties": { "version": { "type": "integer", "description": "Optional. Which version to use for evaluation.", "format": "int32" } }, "id": "GoogleCloudAiplatformV1beta1SafetySpec" }, "GoogleCloudAiplatformV1beta1ToolParameterKeyMatchInput": { "type": "object", "properties": { "instances": { "description": "Required. Repeated tool parameter key match instances.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1ToolParameterKeyMatchInstance" } }, "metricSpec": { "$ref": "GoogleCloudAiplatformV1beta1ToolParameterKeyMatchSpec", "description": "Required. Spec for tool parameter key match metric." } }, "description": "Input for tool parameter key match metric.", "id": "GoogleCloudAiplatformV1beta1ToolParameterKeyMatchInput" }, "GoogleCloudAiplatformV1beta1EvaluationSet": { "id": "GoogleCloudAiplatformV1beta1EvaluationSet", "description": "EvaluationSet is a collection of related EvaluationItems that are evaluated together.", "properties": { "encryptionSpec": { "description": "Optional. Customer-managed encryption key spec for this EvaluationSet. If set, this EvaluationSet and its sub-resources will be secured by this key.", "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec" }, "agentConfigs": { "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1AgentConfig" }, "description": "Optional. Static configurations for each agent associated with the items in this set. Key: `agent_id` (matches the `author` field in `events`). Value: The static configuration of the agent.", "type": "object" }, "createTime": { "format": "google-datetime", "description": "Output only. Timestamp when this item was created.", "type": "string", "readOnly": true }, "metadata": { "description": "Optional. Metadata for the EvaluationSet.", "type": "any" }, "updateTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. Timestamp when this item was last updated." }, "displayName": { "description": "Required. The display name of the EvaluationSet.", "type": "string" }, "name": { "description": "Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", "type": "string" }, "evaluationItems": { "description": "Required. The EvaluationItems that are part of this dataset.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1RetrieveExpressProjectResponse": { "id": "GoogleCloudAiplatformV1beta1RetrieveExpressProjectResponse", "properties": { "expressProject": { "description": "The project for Vertex AI Express Mode.", "$ref": "GoogleCloudAiplatformV1beta1ExpressProject" } }, "description": "Response message for ExpressModeService.RetrieveExpressProject.", "type": "object" }, "GoogleCloudAiplatformV1beta1CoherenceResult": { "properties": { "score": { "description": "Output only. Coherence score.", "format": "float", "type": "number", "readOnly": true }, "explanation": { "type": "string", "readOnly": true, "description": "Output only. Explanation for coherence score." }, "confidence": { "type": "number", "format": "float", "readOnly": true, "description": "Output only. Confidence for coherence score." } }, "type": "object", "description": "Spec for coherence result.", "id": "GoogleCloudAiplatformV1beta1CoherenceResult" }, "GoogleCloudAiplatformV1beta1AssignNotebookRuntimeOperationMetadata": { "type": "object", "description": "Metadata information for NotebookService.AssignNotebookRuntime.", "id": "GoogleCloudAiplatformV1beta1AssignNotebookRuntimeOperationMetadata", "properties": { "progressMessage": { "description": "A human-readable message that shows the intermediate progress details of NotebookRuntime.", "type": "string" }, "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "The operation generic information." } } }, "GoogleCloudAiplatformV1beta1RougeInstance": { "properties": { "reference": { "description": "Required. Ground truth used to compare against the prediction.", "type": "string" }, "prediction": { "description": "Required. Output of the evaluated model.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1RougeInstance", "description": "Spec for rouge instance.", "type": "object" }, "GoogleCloudAiplatformV1beta1ImportIndexRequestConnectorConfigDatapointFieldMapping": { "properties": { "idColumn": { "type": "string", "description": "Required. The column with unique identifiers for each data point." }, "numericRestricts": { "description": "Optional. List of restricts for numeric values.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1ImportIndexRequestConnectorConfigDatapointFieldMappingNumericRestrict" } }, "embeddingColumn": { "type": "string", "description": "Required. The column with the vector embeddings for each data point." }, "restricts": { "description": "Optional. List of restricts for string values.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1ImportIndexRequestConnectorConfigDatapointFieldMappingRestrict" } }, "metadataColumns": { "type": "array", "description": "Optional. List of columns containing metadata to be included in the index.", "items": { "type": "string" } } }, "id": "GoogleCloudAiplatformV1beta1ImportIndexRequestConnectorConfigDatapointFieldMapping", "description": "Mapping of datapoint fields to column names for columnar data sources.", "type": "object" }, "GoogleCloudAiplatformV1beta1UpdateExplanationDatasetRequest": { "properties": { "examples": { "$ref": "GoogleCloudAiplatformV1beta1Examples", "description": "The example config containing the location of the dataset." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1UpdateExplanationDatasetRequest", "description": "Request message for ModelService.UpdateExplanationDataset." }, "GoogleCloudAiplatformV1beta1TrajectoryRecallInstance": { "properties": { "referenceTrajectory": { "description": "Required. Spec for reference tool call trajectory.", "$ref": "GoogleCloudAiplatformV1beta1Trajectory" }, "predictedTrajectory": { "$ref": "GoogleCloudAiplatformV1beta1Trajectory", "description": "Required. Spec for predicted tool call trajectory." } }, "description": "Spec for TrajectoryRecall instance.", "id": "GoogleCloudAiplatformV1beta1TrajectoryRecallInstance", "type": "object" }, "GenaiVertexV1beta1GoogleMapsCallDelta": { "type": "object", "properties": { "arguments": { "$ref": "GenaiVertexV1beta1GoogleMapsCallContentGoogleMapsCallArguments", "description": "The arguments to pass to the Google Maps tool." } }, "id": "GenaiVertexV1beta1GoogleMapsCallDelta" }, "GoogleCloudAiplatformV1beta1GoogleDriveSource": { "description": "The Google Drive location for the input content.", "properties": { "resourceIds": { "description": "Required. Google Drive resource IDs.", "items": { "$ref": "GoogleCloudAiplatformV1beta1GoogleDriveSourceResourceId" }, "type": "array" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1GoogleDriveSource" }, "GoogleCloudAiplatformV1beta1ExamplesArrayFilter": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ExamplesArrayFilter", "description": "Filters for examples' array metadata fields. An array field is example metadata where multiple values are attributed to a single example.", "properties": { "values": { "type": "array", "description": "Required. The values by which to filter examples.", "items": { "type": "string" } }, "arrayOperator": { "description": "Required. The operator logic to use for filtering.", "type": "string", "enum": [ "ARRAY_OPERATOR_UNSPECIFIED", "CONTAINS_ANY", "CONTAINS_ALL" ], "enumDescriptions": [ "Not specified. This value should not be used.", "The metadata array field in the example must contain at least one of the values.", "The metadata array field in the example must contain all of the values." ] } } }, "GoogleCloudAiplatformV1beta1BleuInput": { "id": "GoogleCloudAiplatformV1beta1BleuInput", "properties": { "metricSpec": { "$ref": "GoogleCloudAiplatformV1beta1BleuSpec", "description": "Required. Spec for bleu score metric." }, "instances": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1BleuInstance" }, "description": "Required. Repeated bleu instances." } }, "description": "Input for bleu metric.", "type": "object" }, "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob", "description": "Represents a job that runs periodically to monitor the deployed models in an endpoint. It will analyze the logged training & prediction data to detect any abnormal behaviors.", "properties": { "satisfiesPzs": { "readOnly": true, "description": "Output only. Reserved for future use.", "type": "boolean" }, "createTime": { "description": "Output only. Timestamp when this ModelDeploymentMonitoringJob was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "predictInstanceSchemaUri": { "description": "YAML schema file uri describing the format of a single instance, which are given to format this Endpoint's prediction (and explanation). If not set, we will generate predict schema from collected predict requests.", "type": "string" }, "state": { "description": "Output only. The detailed state of the monitoring job. When the job is still creating, the state will be 'PENDING'. Once the job is successfully created, the state will be 'RUNNING'. Pause the job, the state will be 'PAUSED'. Resume the job, the state will return to 'RUNNING'.", "enum": [ "JOB_STATE_UNSPECIFIED", "JOB_STATE_QUEUED", "JOB_STATE_PENDING", "JOB_STATE_RUNNING", "JOB_STATE_SUCCEEDED", "JOB_STATE_FAILED", "JOB_STATE_CANCELLING", "JOB_STATE_CANCELLED", "JOB_STATE_PAUSED", "JOB_STATE_EXPIRED", "JOB_STATE_UPDATING", "JOB_STATE_PARTIALLY_SUCCEEDED" ], "type": "string", "readOnly": true, "enumDescriptions": [ "The job state is unspecified.", "The job has been just created or resumed and processing has not yet begun.", "The service is preparing to run the job.", "The job is in progress.", "The job completed successfully.", "The job failed.", "The job is being cancelled. From this state the job may only go to either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.", "The job has been cancelled.", "The job has been stopped, and can be resumed.", "The job has expired.", "The job is being updated. Only jobs in the `RUNNING` state can be updated. After updating, the job goes back to the `RUNNING` state.", "The job is partially succeeded, some results may be missing due to errors." ] }, "loggingSamplingStrategy": { "description": "Required. Sample Strategy for logging.", "$ref": "GoogleCloudAiplatformV1beta1SamplingStrategy" }, "modelDeploymentMonitoringObjectiveConfigs": { "type": "array", "description": "Required. The config for monitoring objectives. This is a per DeployedModel config. Each DeployedModel needs to be configured separately.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringObjectiveConfig" } }, "endpoint": { "description": "Required. Endpoint resource name. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "type": "string" }, "error": { "description": "Output only. Only populated when the job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.", "readOnly": true, "$ref": "GoogleRpcStatus" }, "encryptionSpec": { "description": "Customer-managed encryption key spec for a ModelDeploymentMonitoringJob. If set, this ModelDeploymentMonitoringJob and all sub-resources of this ModelDeploymentMonitoringJob will be secured by this key.", "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec" }, "samplePredictInstance": { "type": "any", "description": "Sample Predict instance, same format as PredictRequest.instances, this can be set as a replacement of ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not set, we will generate predict schema from collected predict requests." }, "bigqueryTables": { "type": "array", "description": "Output only. The created bigquery tables for the job under customer project. Customer could do their own query & analysis. There could be 4 log tables in maximum: 1. Training data logging predict request/response 2. Serving data logging predict request/response", "readOnly": true, "items": { "$ref": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringBigQueryTable" } }, "nextScheduleTime": { "description": "Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round.", "type": "string", "readOnly": true, "format": "google-datetime" }, "enableMonitoringPipelineLogs": { "description": "If true, the scheduled monitoring pipeline logs are sent to Google Cloud Logging, including pipeline status and anomalies detected. Please note the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging#pricing).", "type": "boolean" }, "logTtl": { "format": "google-duration", "description": "The TTL of BigQuery tables in user projects which stores logs. A day is the basic unit of the TTL and we take the ceil of TTL/86400(a day). e.g. { second: 3600} indicates ttl = 1 day.", "type": "string" }, "latestMonitoringPipelineMetadata": { "description": "Output only. Latest triggered monitoring pipeline metadata.", "$ref": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata", "readOnly": true }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" }, "analysisInstanceSchemaUri": { "type": "string", "description": "YAML schema file uri describing the format of a single instance that you want Tensorflow Data Validation (TFDV) to analyze. If this field is empty, all the feature data types are inferred from predict_instance_schema_uri, meaning that TFDV will use the data in the exact format(data type) as prediction request/response. If there are any data type differences between predict instance and TFDV instance, this field can be used to override the schema. For models trained with Vertex AI, this field must be set as all the fields in predict instance formatted as string." }, "modelDeploymentMonitoringScheduleConfig": { "$ref": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringScheduleConfig", "description": "Required. Schedule config for running the monitoring job." }, "displayName": { "type": "string", "description": "Required. The user-defined name of the ModelDeploymentMonitoringJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. Display name of a ModelDeploymentMonitoringJob." }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The labels with user-defined metadata to organize your ModelDeploymentMonitoringJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels." }, "statsAnomaliesBaseDirectory": { "$ref": "GoogleCloudAiplatformV1beta1GcsDestination", "description": "Stats anomalies base folder path." }, "modelMonitoringAlertConfig": { "description": "Alert config for model monitoring.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringAlertConfig" }, "name": { "type": "string", "description": "Output only. Resource name of a ModelDeploymentMonitoringJob.", "readOnly": true }, "scheduleState": { "type": "string", "readOnly": true, "description": "Output only. Schedule state when the monitoring job is in Running state.", "enumDescriptions": [ "Unspecified state.", "The pipeline is picked up and wait to run.", "The pipeline is offline and will be scheduled for next run.", "The pipeline is running." ], "enum": [ "MONITORING_SCHEDULE_STATE_UNSPECIFIED", "PENDING", "OFFLINE", "RUNNING" ] }, "updateTime": { "format": "google-datetime", "description": "Output only. Timestamp when this ModelDeploymentMonitoringJob was updated most recently.", "readOnly": true, "type": "string" } } }, "GoogleCloudAiplatformV1beta1FeatureViewDataKey": { "description": "Lookup key for a feature view.", "properties": { "key": { "description": "String key to use for lookup.", "type": "string" }, "compositeKey": { "description": "The actual Entity ID will be composed from this struct. This should match with the way ID is defined in the FeatureView spec.", "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDataKeyCompositeKey" } }, "id": "GoogleCloudAiplatformV1beta1FeatureViewDataKey", "type": "object" }, "GoogleCloudAiplatformV1beta1StructFieldValue": { "properties": { "value": { "$ref": "GoogleCloudAiplatformV1beta1FeatureValue", "description": "The value for this field." }, "name": { "description": "Name of the field in the struct feature.", "type": "string" } }, "description": "One field of a Struct (or object) type feature value.", "type": "object", "id": "GoogleCloudAiplatformV1beta1StructFieldValue" }, "GoogleCloudAiplatformV1beta1MemoryFilter": { "id": "GoogleCloudAiplatformV1beta1MemoryFilter", "type": "object", "properties": { "key": { "type": "string", "description": "Represents the key of the filter. For example, \"author\" would apply to `metadata` entries with the key \"author\"." }, "op": { "enum": [ "OPERATOR_UNSPECIFIED", "EQUAL", "GREATER_THAN", "LESS_THAN" ], "enumDescriptions": [ "Represents an unspecified operator. Defaults to EQUAL.", "Equal to.", "Greater than.", "Less than." ], "description": "Represents the operator to apply to the filter. If not set, then EQUAL will be used.", "type": "string" }, "negate": { "description": "Indicates whether the filter will be negated.", "type": "boolean" }, "value": { "$ref": "GoogleCloudAiplatformV1beta1MemoryMetadataValue", "description": "Represents the value to compare to." } }, "description": "Filter to apply when retrieving memories." }, "GoogleCloudAiplatformV1beta1ExportDataOperationMetadata": { "description": "Runtime operation information for DatasetService.ExportData.", "id": "GoogleCloudAiplatformV1beta1ExportDataOperationMetadata", "type": "object", "properties": { "gcsOutputDirectory": { "description": "A Google Cloud Storage directory which path ends with '/'. The exported data is stored in the directory.", "type": "string" }, "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "The common part of the operation metadata." } } }, "GoogleCloudAiplatformV1beta1ListReasoningEngineRuntimeRevisionsResponse": { "properties": { "nextPageToken": { "description": "A token to retrieve the next page of results. Pass to ListReasoningEngineRuntimeRevisionsRequest.page_token to obtain that page.", "type": "string" }, "reasoningEngineRuntimeRevisions": { "items": { "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineRuntimeRevision" }, "type": "array", "description": "List of ReasoningEngineRuntimeRevisions in the requested page." } }, "description": "Response message for ReasoningEngineRuntimeRevisionService.ListReasoningEngineRuntimeRevisions", "id": "GoogleCloudAiplatformV1beta1ListReasoningEngineRuntimeRevisionsResponse", "type": "object" }, "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentSnapshotsResponse": { "properties": { "sandboxEnvironmentSnapshots": { "items": { "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentSnapshot" }, "type": "array", "description": "The SandboxEnvironmentSnapshots matching the request." }, "nextPageToken": { "description": "A token, which can be sent as ListSandboxEnvironmentSnapshotsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", "type": "string" } }, "description": "Response message for SandboxEnvironmentService.ListSandboxEnvironmentSnapshots.", "id": "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentSnapshotsResponse", "type": "object" }, "GoogleCloudAiplatformV1beta1FetchPredictOperationRequest": { "description": "Request message for PredictionService.FetchPredictOperation.", "type": "object", "id": "GoogleCloudAiplatformV1beta1FetchPredictOperationRequest", "properties": { "operationName": { "description": "Required. The server-assigned name for the operation.", "type": "string" } } }, "GenaiVertexV1beta1InteractionUsageModalityTokens": { "description": "The token count for a single response modality.", "properties": { "tokens": { "type": "integer", "format": "int32", "description": "Number of tokens for the modality." }, "modality": { "enumDescriptions": [ "Default value. This value is unused.", "Indicates the model should return text.", "Indicates the model should return images.", "Indicates the model should return audio.", "Indicates the model should return video.", "Indicates the model should return documents." ], "description": "The modality associated with the token count.", "type": "string", "enum": [ "RESPONSE_MODALITY_UNSPECIFIED", "TEXT", "IMAGE", "AUDIO", "VIDEO", "DOCUMENT" ] } }, "type": "object", "id": "GenaiVertexV1beta1InteractionUsageModalityTokens" }, "GoogleCloudAiplatformV1beta1BatchPredictionJobInputConfig": { "id": "GoogleCloudAiplatformV1beta1BatchPredictionJobInputConfig", "description": "Configures the input to BatchPredictionJob. See Model.supported_input_storage_formats for Model's supported input formats, and how instances should be expressed via any of them.", "type": "object", "properties": { "vertexMultimodalDatasetSource": { "description": "A Vertex Managed Dataset. Currently, only datasets of type Multimodal are supported.", "$ref": "GoogleCloudAiplatformV1beta1VertexMultimodalDatasetSource" }, "instancesFormat": { "description": "Required. The format in which instances are given, must be one of the Model's supported_input_storage_formats.", "type": "string" }, "bigquerySource": { "description": "The BigQuery location of the input table. The schema of the table should be in the format described by the given context OpenAPI Schema, if one is provided. The table may contain additional columns that are not described by the schema, and they will be ignored.", "$ref": "GoogleCloudAiplatformV1beta1BigQuerySource" }, "gcsSource": { "description": "The Cloud Storage location for the input instances.", "$ref": "GoogleCloudAiplatformV1beta1GcsSource" } } }, "GoogleCloudAiplatformV1beta1ListFeatureViewSyncsResponse": { "properties": { "featureViewSyncs": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1FeatureViewSync" }, "description": "The FeatureViewSyncs matching the request." }, "nextPageToken": { "type": "string", "description": "A token, which can be sent as ListFeatureViewSyncsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ListFeatureViewSyncsResponse", "description": "Response message for FeatureOnlineStoreAdminService.ListFeatureViewSyncs." }, "GoogleCloudAiplatformV1beta1ModelMonitoringSchemaFieldSchema": { "id": "GoogleCloudAiplatformV1beta1ModelMonitoringSchemaFieldSchema", "type": "object", "description": "Schema field definition.", "properties": { "name": { "description": "Field name.", "type": "string" }, "dataType": { "description": "Supported data types are: `float` `integer` `boolean` `string` `categorical`", "type": "string" }, "repeated": { "type": "boolean", "description": "Describes if the schema field is an array of given data type." } } }, "GoogleCloudAiplatformV1beta1GroundingSupport": { "description": "A collection of supporting references for a segment or part of the model's response.", "type": "object", "properties": { "segment": { "description": "The content segment that this support message applies to.", "$ref": "GoogleCloudAiplatformV1beta1Segment" }, "renderedParts": { "items": { "type": "integer", "format": "int32" }, "type": "array", "description": "Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message." }, "groundingChunkIndices": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment." }, "confidenceScores": { "description": "The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored.", "type": "array", "items": { "format": "float", "type": "number" } } }, "id": "GoogleCloudAiplatformV1beta1GroundingSupport" }, "GoogleCloudAiplatformV1beta1CancelHyperparameterTuningJobRequest": { "properties": {}, "description": "Request message for JobService.CancelHyperparameterTuningJob.", "type": "object", "id": "GoogleCloudAiplatformV1beta1CancelHyperparameterTuningJobRequest" }, "GenaiVertexV1beta1CodeExecutionResultDelta": { "id": "GenaiVertexV1beta1CodeExecutionResultDelta", "type": "object", "properties": { "result": { "type": "string" }, "isError": { "type": "boolean" } } }, "GoogleCloudAiplatformV1beta1CoherenceInstance": { "type": "object", "id": "GoogleCloudAiplatformV1beta1CoherenceInstance", "properties": { "prediction": { "type": "string", "description": "Required. Output of the evaluated model." } }, "description": "Spec for coherence instance." }, "GenaiVertexV1beta1GoogleSearchResultStep": { "description": "Google Search result step.", "properties": { "result": { "description": "Required. The results of the Google Search.", "items": { "$ref": "GenaiVertexV1beta1GoogleSearchResultStepGoogleSearchResultItem" }, "type": "array" }, "isError": { "description": "Whether the Google Search resulted in an error.", "type": "boolean" } }, "type": "object", "id": "GenaiVertexV1beta1GoogleSearchResultStep" }, "CloudAiLargeModelsVisionRaiInfoDetectedLabels": { "type": "object", "properties": { "entities": { "description": "The list of detected entities for the rai signal.", "items": { "$ref": "CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity" }, "type": "array" }, "raiCategory": { "type": "string", "description": "The RAI category for the deteceted labels." } }, "id": "CloudAiLargeModelsVisionRaiInfoDetectedLabels", "description": "Filters returning list of deteceted labels, scores, and bounding boxes." }, "GoogleCloudAiplatformV1beta1AutoscalingMetricSpec": { "id": "GoogleCloudAiplatformV1beta1AutoscalingMetricSpec", "properties": { "monitoredResourceLabels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "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" }, "target": { "format": "int32", "type": "integer", "description": "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." }, "metricName": { "type": "string", "description": "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` * `pubsub.googleapis.com/subscription/num_undelivered_messages` * `prometheus.googleapis.com/vertex_dcgm_fi_dev_gpu_util` * `prometheus.googleapis.com/vertex_vllm_gpu_cache_usage_perc` * `prometheus.googleapis.com/vertex_vllm_num_requests_waiting`" } }, "type": "object", "description": "The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count." }, "GoogleCloudAiplatformV1beta1BatchCreateTensorboardTimeSeriesRequest": { "description": "Request message for TensorboardService.BatchCreateTensorboardTimeSeries.", "properties": { "requests": { "items": { "$ref": "GoogleCloudAiplatformV1beta1CreateTensorboardTimeSeriesRequest" }, "type": "array", "description": "Required. The request message specifying the TensorboardTimeSeries to create. A maximum of 1000 TensorboardTimeSeries can be created in a batch." } }, "id": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardTimeSeriesRequest", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation": { "properties": { "columnName": { "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation", "type": "object", "description": "Training pipeline will perform following transformation functions. * The value converted to float32. * The z_score of the value. * log(value+1) when the value is greater than or equal to 0. Otherwise, this transformation is not applied and the value is considered a missing value. * z_score of log(value+1) when the value is greater than or equal to 0. Otherwise, this transformation is not applied and the value is considered a missing value." }, "GoogleCloudAiplatformV1beta1FluencyResult": { "type": "object", "properties": { "confidence": { "type": "number", "description": "Output only. Confidence for fluency score.", "format": "float", "readOnly": true }, "explanation": { "description": "Output only. Explanation for fluency score.", "readOnly": true, "type": "string" }, "score": { "description": "Output only. Fluency score.", "readOnly": true, "format": "float", "type": "number" } }, "id": "GoogleCloudAiplatformV1beta1FluencyResult", "description": "Spec for fluency result." }, "GoogleCloudAiplatformV1beta1StoredContentsExampleFilter": { "id": "GoogleCloudAiplatformV1beta1StoredContentsExampleFilter", "properties": { "searchKeys": { "description": "Optional. The search keys for filtering. Only examples with one of the specified search keys (StoredContentsExample.search_key) are eligible to be returned.", "items": { "type": "string" }, "type": "array" }, "functionNames": { "description": "Optional. The function names for filtering.", "$ref": "GoogleCloudAiplatformV1beta1ExamplesArrayFilter" } }, "type": "object", "description": "The metadata filters that will be used to remove or fetch StoredContentsExamples. If a field is unspecified, then no filtering for that field will be applied." }, "GoogleCloudAiplatformV1beta1ListServingProfilesResponse": { "properties": { "nextPageToken": { "readOnly": true, "description": "Output only. A token to retrieve the next page of results.", "type": "string" }, "servingProfiles": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1ServingProfile" }, "description": "Output only. A list of ServingProfiles.", "readOnly": true } }, "description": "Response message for ServingProfileService.ListServingProfiles.", "id": "GoogleCloudAiplatformV1beta1ListServingProfilesResponse", "type": "object" }, "GoogleCloudAiplatformV1beta1ListFeatureGroupsResponse": { "type": "object", "description": "Response message for FeatureRegistryService.ListFeatureGroups.", "id": "GoogleCloudAiplatformV1beta1ListFeatureGroupsResponse", "properties": { "featureGroups": { "description": "The FeatureGroups matching the request.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1FeatureGroup" } }, "nextPageToken": { "description": "A token, which can be sent as ListFeatureGroupsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1EmbedContentResponseEmbedding": { "description": "A list of floats representing an embedding.", "type": "object", "id": "GoogleCloudAiplatformV1beta1EmbedContentResponseEmbedding", "properties": { "values": { "items": { "type": "number", "format": "float" }, "type": "array", "description": "Embedding vector values." } } }, "GoogleCloudAiplatformV1beta1ListTensorboardTimeSeriesResponse": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ListTensorboardTimeSeriesResponse", "properties": { "nextPageToken": { "type": "string", "description": "A token, which can be sent as ListTensorboardTimeSeriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "tensorboardTimeSeries": { "items": { "$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" }, "description": "The TensorboardTimeSeries mathching the request.", "type": "array" } }, "description": "Response message for TensorboardService.ListTensorboardTimeSeries." }, "GoogleCloudAiplatformV1beta1TaskArtifact": { "properties": { "parts": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Part" }, "description": "Required. The content of the artifact.", "type": "array" }, "displayName": { "description": "Optional. The human-readable name of the artifact provided by the creator.", "type": "string" }, "artifactId": { "description": "Required. The unique identifier of the artifact within the task. This id is provided by the creator of the artifact.", "type": "string" }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. Additional metadata for the artifact. For A2A, the URIs of the extensions that were used to produce this artifact will be stored here.", "type": "object" }, "description": { "description": "Optional. A human readable description of the artifact.", "type": "string" } }, "type": "object", "description": "Represents a single artifact produced by a task. sample: artifacts: { artifact_id: \"image-12345\" name: \"Generated Sunset Image\" description: \"A beautiful sunset over the mountains, generated by the user's request.\" parts: { inline_data: { mime_type: \"image/png\" data: \"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAA=\" } } }", "id": "GoogleCloudAiplatformV1beta1TaskArtifact" }, "GoogleCloudAiplatformV1beta1Candidate": { "description": "A response candidate generated from the model.", "type": "object", "properties": { "content": { "$ref": "GoogleCloudAiplatformV1beta1Content", "description": "Output only. The content of the candidate.", "readOnly": true }, "finishReason": { "description": "Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating.", "enum": [ "FINISH_REASON_UNSPECIFIED", "STOP", "MAX_TOKENS", "SAFETY", "RECITATION", "OTHER", "BLOCKLIST", "PROHIBITED_CONTENT", "SPII", "MALFORMED_FUNCTION_CALL", "MODEL_ARMOR", "IMAGE_SAFETY", "IMAGE_PROHIBITED_CONTENT", "IMAGE_RECITATION", "IMAGE_OTHER", "UNEXPECTED_TOOL_CALL", "NO_IMAGE" ], "enumDescriptions": [ "The finish reason is unspecified.", "The model reached a natural stopping point or a configured stop sequence.", "The model generated the maximum number of tokens allowed by the `max_output_tokens` parameter.", "The model stopped generating because the content potentially violates safety policies. NOTE: When streaming, the `content` field is empty if content filters block the output.", "The model stopped generating because the content may be a recitation from a source.", "The model stopped generating for a reason not otherwise specified.", "The model stopped generating because the content contains a term from a configured blocklist.", "The model stopped generating because the content may be prohibited.", "The model stopped generating because the content may contain sensitive personally identifiable information (SPII).", "The model generated a function call that is syntactically invalid and can't be parsed.", "The model response was blocked by Model Armor.", "The generated image potentially violates safety policies.", "The generated image may contain prohibited content.", "The generated image may be a recitation from a source.", "The image generation stopped for a reason not otherwise specified.", "The model generated a function call that is semantically invalid. This can happen, for example, if function calling is not enabled or the generated function is not in the function declaration.", "The model was expected to generate an image, but didn't." ], "type": "string", "readOnly": true }, "groundingMetadata": { "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1GroundingMetadata", "description": "Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content." }, "citationMetadata": { "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1CitationMetadata", "description": "Output only. A collection of citations that apply to the generated content." }, "avgLogprobs": { "type": "number", "readOnly": true, "format": "double", "description": "Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response." }, "safetyRatings": { "readOnly": true, "type": "array", "description": "Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category.", "items": { "$ref": "GoogleCloudAiplatformV1beta1SafetyRating" } }, "logprobsResult": { "$ref": "GoogleCloudAiplatformV1beta1LogprobsResult", "description": "Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential \"hallucinations\".", "readOnly": true }, "urlContextMetadata": { "description": "Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.", "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1UrlContextMetadata" }, "index": { "type": "integer", "format": "int32", "readOnly": true, "description": "Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` \u003e 1." }, "finishMessage": { "readOnly": true, "description": "Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1Candidate" }, "GoogleCloudAiplatformV1beta1ListSessionsResponse": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ListSessionsResponse", "description": "Response message for SessionService.ListSessions.", "properties": { "sessions": { "type": "array", "description": "A list of sessions matching the request.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Session" } }, "nextPageToken": { "type": "string", "description": "A token, which can be sent as ListSessionsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages." } } }, "GoogleCloudAiplatformV1beta1AssembleDataRequest": { "description": "Request message for DatasetService.AssembleData. Used only for MULTIMODAL datasets.", "properties": { "geminiRequestReadConfig": { "$ref": "GoogleCloudAiplatformV1beta1GeminiRequestReadConfig", "description": "Optional. The read config for the dataset." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1AssembleDataRequest" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionHyperparameterTuningTask": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionHyperparameterTuningTask", "description": "A TrainingJob that tunes Hypererparameters of a custom code Model.", "properties": { "metadata": { "description": "The metadata information.", "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionHyperparameterTuningJobMetadata" }, "inputs": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec", "description": "The input parameters of this HyperparameterTuningTask." } } }, "GoogleCloudAiplatformV1beta1InferenceEventLoggingConfig": { "type": "object", "id": "GoogleCloudAiplatformV1beta1InferenceEventLoggingConfig", "properties": { "state": { "enumDescriptions": [ "Not specified. Treated as `DISABLED`.", "Inference-event logging is enabled.", "Inference-event logging is disabled." ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "ENABLED", "DISABLED" ], "description": "Optional. Whether the `aiplatform.googleapis.com/inference_request` log is enabled." } }, "description": "Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log." }, "GoogleCloudAiplatformV1beta1SummarizationVerbosityResult": { "description": "Spec for summarization verbosity result.", "id": "GoogleCloudAiplatformV1beta1SummarizationVerbosityResult", "properties": { "confidence": { "readOnly": true, "format": "float", "description": "Output only. Confidence for summarization verbosity score.", "type": "number" }, "explanation": { "type": "string", "description": "Output only. Explanation for summarization verbosity score.", "readOnly": true }, "score": { "readOnly": true, "format": "float", "description": "Output only. Summarization Verbosity score.", "type": "number" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1UpdateDeploymentResourcePoolOperationMetadata": { "type": "object", "id": "GoogleCloudAiplatformV1beta1UpdateDeploymentResourcePoolOperationMetadata", "properties": { "genericMetadata": { "description": "The operation generic information.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "description": "Runtime operation information for UpdateDeploymentResourcePool method." }, "GoogleCloudAiplatformV1beta1EnableMonitoredAgentRequest": { "type": "object", "description": "Request message for AgentAnomalyDetectionService.EnableMonitoredAgent.", "properties": {}, "id": "GoogleCloudAiplatformV1beta1EnableMonitoredAgentRequest" }, "GenaiVertexV1beta1GoogleMapsResultStepGoogleMapsResultItemGoogleMapsResultPlaces": { "id": "GenaiVertexV1beta1GoogleMapsResultStepGoogleMapsResultItemGoogleMapsResultPlaces", "type": "object", "properties": { "reviewSnippets": { "type": "array", "items": { "$ref": "GenaiVertexV1beta1ReviewSnippet" } }, "name": { "type": "string" }, "url": { "type": "string" }, "placeId": { "type": "string" } } }, "GoogleCloudAiplatformV1beta1GeminiAgentConfig": { "description": "Config for scraping a Gemini Agent (a Vertex AI Agent resource scraped via the Vertex Interactions API).", "type": "object", "id": "GoogleCloudAiplatformV1beta1GeminiAgentConfig", "properties": { "geminiAgent": { "description": "Required. The resource name of the Gemini Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`. For example: `projects/123/locations/us-central1/agents/my-agent`.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1CometInput": { "description": "Input for Comet metric.", "id": "GoogleCloudAiplatformV1beta1CometInput", "properties": { "instance": { "$ref": "GoogleCloudAiplatformV1beta1CometInstance", "description": "Required. Comet instance." }, "metricSpec": { "description": "Required. Spec for comet metric.", "$ref": "GoogleCloudAiplatformV1beta1CometSpec" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequest": { "id": "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequest", "type": "object", "properties": { "filterGroups": { "items": { "$ref": "GoogleCloudAiplatformV1beta1MemoryConjunctionFilter" }, "description": "Optional. Metadata filters that will be applied to the retrieved memories' `metadata` using OR logic. Filters are defined using disjunctive normal form (OR of ANDs). For example: `filter_groups: [{filters: [{key: \"author\", value: {string_value: \"agent 123\"}, op: EQUAL}]}, {filters: [{key: \"label\", value: {string_value: \"travel\"}, op: EQUAL}, {key: \"author\", value: {string_value: \"agent 321\"}, op: EQUAL}]}]` would be equivalent to the logical expression: `(metadata.author = \"agent 123\" OR (metadata.label = \"travel\" AND metadata.author = \"agent 321\"))`.", "type": "array" }, "simpleRetrievalParams": { "$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequestSimpleRetrievalParams", "description": "Parameters for simple (non-similarity search) retrieval." }, "scope": { "description": "Required. The scope of the memories to retrieve. A memory must have exactly the same scope (`Memory.scope`) as the scope provided here to be retrieved (same keys and values). Order does not matter, but it is case-sensitive.", "additionalProperties": { "type": "string" }, "type": "object" }, "similaritySearchParams": { "description": "Parameters for semantic similarity search based retrieval.", "$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequestSimilaritySearchParams" }, "filter": { "type": "string", "description": "Optional. The standard list filter that will be applied to the retrieved memories. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `fact` * `create_time` * `update_time` * `topics` (i.e. `topics.custom_memory_topic_label: \"example topic\" OR topics.managed_memory_topic: USER_PREFERENCES`)" }, "memoryTypes": { "description": "Optional. Specifies the types of memories to retrieve. If this field is empty or not provided, the request will default to retrieving only memories of type `NATURAL_LANGUAGE_COLLECTION`. If populated, the request will retrieve memories matching any of the specified `MemoryType` values.", "items": { "enumDescriptions": [ "Represents an unspecified memory type. This value should not be used.", "Indicates belonging to a collection of natural language memories.", "Indicates belonging to a structured profile." ], "enum": [ "MEMORY_TYPE_UNSPECIFIED", "NATURAL_LANGUAGE_COLLECTION", "STRUCTURED_PROFILE" ], "type": "string" }, "type": "array" } }, "description": "Request message for MemoryBankService.RetrieveMemories." }, "GoogleCloudAiplatformV1beta1RagMetadata": { "id": "GoogleCloudAiplatformV1beta1RagMetadata", "properties": { "userSpecifiedMetadata": { "description": "User provided metadata.", "$ref": "GoogleCloudAiplatformV1beta1UserSpecifiedMetadata" }, "name": { "type": "string", "description": "Identifier. Resource name of the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}`" } }, "type": "object", "description": "Metadata for RagFile provided by users." }, "GoogleCloudAiplatformV1beta1ModelMonitoringInputModelMonitoringDatasetModelMonitoringGcsSource": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ModelMonitoringInputModelMonitoringDatasetModelMonitoringGcsSource", "properties": { "gcsUri": { "description": "Google Cloud Storage URI to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.", "type": "string" }, "format": { "type": "string", "enumDescriptions": [ "Data format unspecified, used when this field is unset.", "CSV files.", "TfRecord files", "JsonL files." ], "enum": [ "DATA_FORMAT_UNSPECIFIED", "CSV", "TF_RECORD", "JSONL" ], "description": "Data format of the dataset." } }, "description": "Dataset spec for data stored in Google Cloud Storage." }, "GoogleCloudAiplatformV1beta1Schedule": { "properties": { "name": { "description": "Immutable. The resource name of the Schedule.", "type": "string" }, "maxConcurrentActiveRunCount": { "format": "int64", "description": "Optional. Specifies the maximum number of active runs that can be executed concurrently for this Schedule. This limits the number of runs that can be in a non-terminal state at the same time. Currently, this field is only supported for requests of type CreatePipelineJobRequest.", "type": "string" }, "startedRunCount": { "readOnly": true, "type": "string", "format": "int64", "description": "Output only. The number of runs started by this schedule." }, "createNotebookExecutionJobRequest": { "description": "Request for NotebookService.CreateNotebookExecutionJob.", "$ref": "GoogleCloudAiplatformV1beta1CreateNotebookExecutionJobRequest" }, "displayName": { "description": "Required. User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters.", "type": "string" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when this Schedule was created." }, "startTime": { "description": "Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.", "format": "google-datetime", "type": "string" }, "catchUp": { "type": "boolean", "description": "Output only. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. Default to false.", "readOnly": true }, "lastScheduledRunResponse": { "$ref": "GoogleCloudAiplatformV1beta1ScheduleRunResponse", "description": "Output only. Response of the last scheduled run. This is the response for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). Unset if no run has been scheduled yet.", "readOnly": true }, "updateTime": { "description": "Output only. Timestamp when this Schedule was updated.", "format": "google-datetime", "readOnly": true, "type": "string" }, "state": { "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "PAUSED", "COMPLETED" ], "enumDescriptions": [ "Unspecified.", "The Schedule is active. Runs are being scheduled on the user-specified timespec.", "The schedule is paused. No new runs will be created until the schedule is resumed. Already started runs will be allowed to complete.", "The Schedule is completed. No new runs will be scheduled. Already started runs will be allowed to complete. Schedules in completed state cannot be paused or resumed." ], "type": "string", "description": "Output only. The state of this Schedule." }, "cron": { "description": "Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: \"CRON_TZ=${IANA_TIME_ZONE}\" or \"TZ=${IANA_TIME_ZONE}\". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, \"CRON_TZ=America/New_York 1 * * * *\", or \"TZ=America/New_York 1 * * * *\".", "type": "string" }, "createModelMonitoringJobRequest": { "description": "Request for ModelMonitoringService.CreateModelMonitoringJob.", "$ref": "GoogleCloudAiplatformV1beta1CreateModelMonitoringJobRequest" }, "createPipelineJobRequest": { "description": "Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).", "$ref": "GoogleCloudAiplatformV1beta1CreatePipelineJobRequest" }, "lastResumeTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause." }, "allowQueueing": { "type": "boolean", "description": "Optional. Whether new scheduled runs can be queued when max_concurrent_runs limit is reached. If set to true, new runs will be queued instead of skipped. Default to false." }, "maxRunCount": { "format": "int64", "description": "Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count \u003e= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.", "type": "string" }, "nextRunTime": { "format": "google-datetime", "description": "Output only. Timestamp when this Schedule should schedule the next run. Having a next_run_time in the past means the runs are being started behind schedule.", "readOnly": true, "type": "string" }, "endTime": { "type": "string", "format": "google-datetime", "description": "Optional. Timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either end_time is reached or when scheduled_run_count \u003e= max_run_count. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified." }, "lastPauseTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Timestamp when this Schedule was last paused. Unset if never paused.", "type": "string" }, "maxConcurrentRunCount": { "description": "Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).", "format": "int64", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1Schedule", "description": "An instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaTextSegment": { "id": "GoogleCloudAiplatformV1beta1SchemaTextSegment", "properties": { "startOffset": { "format": "uint64", "description": "Zero-based character index of the first character of the text segment (counting characters from the beginning of the text).", "type": "string" }, "content": { "description": "The text content in the segment for output only.", "type": "string" }, "endOffset": { "description": "Zero-based character index of the first character past the end of the text segment (counting character from the beginning of the text). The character at the end_offset is NOT included in the text segment.", "type": "string", "format": "uint64" } }, "type": "object", "description": "The text segment inside of DataItem." }, "GoogleCloudAiplatformV1beta1TaskArtifactChange": { "id": "GoogleCloudAiplatformV1beta1TaskArtifactChange", "description": "Describes changes to the artifact list.", "properties": { "deletedArtifactIds": { "description": "Optional. A list of artifact IDs that were removed in this event.", "items": { "type": "string" }, "type": "array" }, "addedArtifacts": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1TaskArtifact" }, "description": "Optional. A list of brand-new artifacts created in this event." }, "updatedArtifacts": { "items": { "$ref": "GoogleCloudAiplatformV1beta1TaskArtifact" }, "type": "array", "description": "Optional. A list of existing artifacts that were modified in this event." } }, "type": "object" }, "GenaiVertexV1beta1RagStoreConfig": { "id": "GenaiVertexV1beta1RagStoreConfig", "type": "object", "properties": { "similarityTopK": { "format": "int32", "deprecated": true, "type": "integer", "description": "Optional. Number of top k results to return from the selected corpora." }, "ragResources": { "description": "Optional. The representation of the rag source.", "items": { "$ref": "GenaiVertexV1beta1RagStoreConfigRagResource" }, "type": "array" }, "vectorDistanceThreshold": { "deprecated": true, "description": "Optional. Only return results with vector distance smaller than the threshold.", "type": "number", "format": "double" }, "ragRetrievalConfig": { "description": "Optional. The retrieval config for the Rag query.", "$ref": "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfig" } }, "description": "Use to specify configuration for RAG Store." }, "GoogleCloudAiplatformV1beta1GenericOperationMetadata": { "description": "Generic Metadata shared by all operations.", "properties": { "createTime": { "format": "google-datetime", "description": "Output only. Time when the operation was created.", "type": "string", "readOnly": true }, "partialFailures": { "type": "array", "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. This field should never exceed 20 entries. Status details field will contain standard Google Cloud error details.", "items": { "$ref": "GoogleRpcStatus" }, "readOnly": true }, "updateTime": { "description": "Output only. Time when the operation was updated for the last time. If the operation has finished (successfully or not), this is the finish time.", "type": "string", "readOnly": true, "format": "google-datetime" } }, "id": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "type": "object" }, "GoogleCloudAiplatformV1beta1UpdateFeatureViewOperationMetadata": { "id": "GoogleCloudAiplatformV1beta1UpdateFeatureViewOperationMetadata", "properties": { "genericMetadata": { "description": "Operation metadata for FeatureView Update.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "description": "Details of operations that perform update FeatureView.", "type": "object" }, "GoogleCloudAiplatformV1beta1ExportPublisherModelResponse": { "properties": { "publisherModel": { "description": "The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}@{version_id}`", "type": "string" }, "destinationUri": { "description": "The destination uri of the model weights.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1ExportPublisherModelResponse", "description": "Response message for ModelGardenService.ExportPublisherModel.", "type": "object" }, "GoogleCloudAiplatformV1beta1ListTuningJobsResponse": { "id": "GoogleCloudAiplatformV1beta1ListTuningJobsResponse", "type": "object", "description": "Response message for GenAiTuningService.ListTuningJobs", "properties": { "nextPageToken": { "description": "A token to retrieve the next page of results. Pass this token in a subsequent [GenAiTuningService.ListTuningJobs] call to retrieve the next page of results.", "type": "string" }, "tuningJobs": { "description": "The tuning jobs that match the request.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1TuningJob" } } } }, "GoogleCloudAiplatformV1beta1OptimizePromptResponse": { "type": "object", "id": "GoogleCloudAiplatformV1beta1OptimizePromptResponse", "description": "Response message for GenAiTuningService.OptimizePrompt", "properties": { "content": { "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1Content", "description": "Output only. The optimized prompt." } } }, "GoogleCloudAiplatformV1beta1DeployedIndexRef": { "description": "Points to a DeployedIndex.", "type": "object", "id": "GoogleCloudAiplatformV1beta1DeployedIndexRef", "properties": { "indexEndpoint": { "type": "string", "description": "Immutable. A resource name of the IndexEndpoint." }, "displayName": { "type": "string", "readOnly": true, "description": "Output only. The display name of the DeployedIndex." }, "deployedIndexId": { "type": "string", "description": "Immutable. The ID of the DeployedIndex in the above IndexEndpoint." } } }, "GoogleCloudAiplatformV1beta1RagCorpus": { "type": "object", "properties": { "ragFilesCount": { "description": "Output only. Number of RagFiles in the RagCorpus. NOTE: This field is not populated in the response of VertexRagDataService.ListRagCorpora.", "type": "integer", "readOnly": true, "format": "int32" }, "encryptionSpec": { "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec", "description": "Optional. Immutable. The CMEK key name used to encrypt at-rest data related to this Corpus. Only applicable to RagManagedDb option for Vector DB. This field can only be set at corpus creation time, and cannot be updated or deleted." }, "vertexAiSearchConfig": { "description": "Optional. Immutable. The config for the Vertex AI Search.", "$ref": "GoogleCloudAiplatformV1beta1VertexAiSearchConfig" }, "satisfiesPzi": { "type": "boolean", "description": "Output only. Reserved for future use.", "readOnly": true }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" }, "updateTime": { "description": "Output only. Timestamp when this RagCorpus was last updated.", "type": "string", "format": "google-datetime", "readOnly": true }, "ragEmbeddingModelConfig": { "deprecated": true, "$ref": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfig", "description": "Optional. Immutable. The embedding model config of the RagCorpus." }, "corpusTypeConfig": { "description": "Optional. The corpus type config of the RagCorpus.", "$ref": "GoogleCloudAiplatformV1beta1RagCorpusCorpusTypeConfig" }, "displayName": { "description": "Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters.", "type": "string" }, "name": { "readOnly": true, "description": "Output only. The resource name of the RagCorpus.", "type": "string" }, "corpusStatus": { "$ref": "GoogleCloudAiplatformV1beta1CorpusStatus", "readOnly": true, "description": "Output only. RagCorpus state." }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when this RagCorpus was created." }, "description": { "description": "Optional. The description of the RagCorpus.", "type": "string" }, "vectorDbConfig": { "description": "Optional. Immutable. The config for the Vector DBs.", "$ref": "GoogleCloudAiplatformV1beta1RagVectorDbConfig" }, "ragVectorDbConfig": { "deprecated": true, "description": "Optional. Immutable. The Vector DB config of the RagCorpus.", "$ref": "GoogleCloudAiplatformV1beta1RagVectorDbConfig" } }, "id": "GoogleCloudAiplatformV1beta1RagCorpus", "description": "A RagCorpus is a RagFile container and a project can have multiple RagCorpora." }, "GoogleCloudAiplatformV1beta1PartnerModelTuningSpec": { "description": "Tuning spec for Partner models.", "type": "object", "properties": { "hyperParameters": { "type": "object", "additionalProperties": { "type": "any" }, "description": "Hyperparameters for tuning. The accepted hyper_parameters and their valid range of values will differ depending on the base model." }, "validationDatasetUri": { "description": "Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file.", "type": "string" }, "trainingDatasetUri": { "type": "string", "description": "Required. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file." } }, "id": "GoogleCloudAiplatformV1beta1PartnerModelTuningSpec" }, "GoogleCloudAiplatformV1beta1ModelEvaluationSliceSlice": { "properties": { "value": { "type": "string", "readOnly": true, "description": "Output only. The value of the dimension in this slice." }, "dimension": { "type": "string", "description": "Output only. The dimension of the slice. Well-known dimensions are: * `annotationSpec`: This slice is on the test data that has either ground truth or prediction with AnnotationSpec.display_name equals to value. * `slice`: This slice is a user customized slice defined by its SliceSpec.", "readOnly": true }, "sliceSpec": { "$ref": "GoogleCloudAiplatformV1beta1ModelEvaluationSliceSliceSliceSpec", "readOnly": true, "description": "Output only. Specification for how the data was sliced." } }, "type": "object", "description": "Definition of a slice.", "id": "GoogleCloudAiplatformV1beta1ModelEvaluationSliceSlice" }, "GoogleCloudAiplatformV1beta1SchemaPromptApiSchema": { "id": "GoogleCloudAiplatformV1beta1SchemaPromptApiSchema", "type": "object", "description": "The A2 schema of a prompt.", "properties": { "structuredPrompt": { "$ref": "GoogleCloudAiplatformV1beta1SchemaPromptSpecStructuredPrompt", "description": "The prompt variation that stores preambles in separate fields." }, "apiSchemaVersion": { "description": "The Schema version that represents changes to the API behavior.", "type": "string" }, "translationPrompt": { "$ref": "GoogleCloudAiplatformV1beta1SchemaPromptSpecTranslationPrompt", "description": "The prompt variation for Translation use case." }, "multimodalPrompt": { "description": "Multimodal prompt which embeds preambles to prompt string.", "$ref": "GoogleCloudAiplatformV1beta1SchemaPromptSpecMultimodalPrompt" }, "executions": { "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaPromptInstancePromptExecution" }, "type": "array", "description": "A list of execution instances for constructing a ready-to-use prompt." } } }, "GoogleCloudAiplatformV1beta1TrajectoryAnyOrderMatchResults": { "properties": { "trajectoryAnyOrderMatchMetricValues": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1TrajectoryAnyOrderMatchMetricValue" }, "description": "Output only. TrajectoryAnyOrderMatch metric values.", "readOnly": true } }, "type": "object", "description": "Results for TrajectoryAnyOrderMatch metric.", "id": "GoogleCloudAiplatformV1beta1TrajectoryAnyOrderMatchResults" }, "GoogleCloudAiplatformV1beta1ListModelsResponse": { "properties": { "models": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Model" }, "type": "array", "description": "List of Models in the requested page." }, "nextPageToken": { "description": "A token to retrieve next page of results. Pass to ListModelsRequest.page_token to obtain that page.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1ListModelsResponse", "type": "object", "description": "Response message for ModelService.ListModels" }, "GoogleCloudAiplatformV1beta1PipelineTaskDetailArtifactList": { "description": "A list of artifact metadata.", "properties": { "artifacts": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Artifact" }, "type": "array", "description": "Output only. A list of artifact metadata.", "readOnly": true } }, "id": "GoogleCloudAiplatformV1beta1PipelineTaskDetailArtifactList", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaPredictPredictionClassificationPredictionResult": { "type": "object", "description": "Prediction output format for Image and Text Classification.", "properties": { "displayNames": { "description": "The display names of the AnnotationSpecs that had been identified, order matches the IDs.", "type": "array", "items": { "type": "string" } }, "ids": { "description": "The resource IDs of the AnnotationSpecs that had been identified.", "items": { "type": "string", "format": "int64" }, "type": "array" }, "confidences": { "type": "array", "items": { "type": "number", "format": "float" }, "description": "The Model's confidences in correctness of the predicted IDs, higher value means higher confidence. Order matches the Ids." } }, "id": "GoogleCloudAiplatformV1beta1SchemaPredictPredictionClassificationPredictionResult" }, "GoogleCloudAiplatformV1beta1ReasoningEngine": { "id": "GoogleCloudAiplatformV1beta1ReasoningEngine", "type": "object", "description": "ReasoningEngine provides a customizable runtime for models to determine which actions to take and in which order.", "properties": { "encryptionSpec": { "description": "Customer-managed encryption key spec for a ReasoningEngine. If set, this ReasoningEngine and all sub-resources of this ReasoningEngine will be secured by this key.", "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec" }, "trafficConfig": { "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineTrafficConfig", "description": "Optional. Traffic distribution configuration for the Reasoning Engine." }, "spec": { "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpec", "description": "Optional. Configurations of the ReasoningEngine" }, "createTime": { "description": "Output only. Timestamp when this ReasoningEngine was created.", "format": "google-datetime", "type": "string", "readOnly": true }, "description": { "description": "Optional. The description of the ReasoningEngine.", "type": "string" }, "displayName": { "description": "Required. The display name of the ReasoningEngine.", "type": "string" }, "etag": { "type": "string", "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens." }, "updateTime": { "description": "Output only. Timestamp when this ReasoningEngine was most recently updated.", "format": "google-datetime", "type": "string", "readOnly": true }, "contextSpec": { "description": "Optional. Configuration for how Agent Engine sub-resources should manage context.", "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineContextSpec" }, "labels": { "description": "Labels for the ReasoningEngine.", "type": "object", "additionalProperties": { "type": "string" } }, "name": { "type": "string", "description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`" } } }, "GoogleCloudAiplatformV1beta1RagEngineConfig": { "properties": { "name": { "type": "string", "description": "Identifier. The name of the RagEngineConfig. Format: `projects/{project}/locations/{location}/ragEngineConfig`" }, "ragManagedDbConfig": { "$ref": "GoogleCloudAiplatformV1beta1RagManagedDbConfig", "description": "The config of the RagManagedDb used by RagEngine." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1RagEngineConfig", "description": "Config for RagEngine." }, "GoogleCloudAiplatformV1beta1SuspendOnlineEvaluatorOperationMetadata": { "id": "GoogleCloudAiplatformV1beta1SuspendOnlineEvaluatorOperationMetadata", "properties": { "genericMetadata": { "description": "Common part of operation metadata.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "type": "object", "description": "Metadata for the SuspendOnlineEvaluator operation." }, "GoogleCloudAiplatformV1beta1BatchDeletePipelineJobsRequest": { "type": "object", "properties": { "names": { "description": "Required. The names of the PipelineJobs to delete. A maximum of 32 PipelineJobs can be deleted in a batch. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}`", "type": "array", "items": { "type": "string" } } }, "id": "GoogleCloudAiplatformV1beta1BatchDeletePipelineJobsRequest", "description": "Request message for PipelineService.BatchDeletePipelineJobs." }, "GoogleCloudAiplatformV1beta1ModelMonitoringJob": { "properties": { "name": { "readOnly": true, "description": "Output only. Resource name of a ModelMonitoringJob. Format: `projects/{project_id}/locations/{location_id}/modelMonitors/{model_monitor_id}/modelMonitoringJobs/{model_monitoring_job_id}`", "type": "string" }, "displayName": { "description": "The display name of the ModelMonitoringJob. The name can be up to 128 characters long and can consist of any UTF-8.", "type": "string" }, "scheduleTime": { "description": "Output only. Timestamp when this ModelMonitoringJob was scheduled. It will only appear when this job is triggered by a schedule.", "format": "google-datetime", "readOnly": true, "type": "string" }, "createTime": { "description": "Output only. Timestamp when this ModelMonitoringJob was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "schedule": { "readOnly": true, "description": "Output only. Schedule resource name. It will only appear when this job is triggered by a schedule.", "type": "string" }, "modelMonitoringSpec": { "description": "Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. If left blank, the default monitoring specifications from the top-level resource 'ModelMonitor' will be applied. If provided, we will use the specification defined here rather than the default one.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringSpec" }, "jobExecutionDetail": { "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringJobExecutionDetail", "description": "Output only. Execution results for all the monitoring objectives." }, "updateTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. Timestamp when this ModelMonitoringJob was updated most recently." }, "state": { "type": "string", "description": "Output only. The state of the monitoring job. * When the job is still creating, the state will be 'JOB_STATE_PENDING'. * Once the job is successfully created, the state will be 'JOB_STATE_RUNNING'. * Once the job is finished, the state will be one of 'JOB_STATE_FAILED', 'JOB_STATE_SUCCEEDED', 'JOB_STATE_PARTIALLY_SUCCEEDED'.", "enum": [ "JOB_STATE_UNSPECIFIED", "JOB_STATE_QUEUED", "JOB_STATE_PENDING", "JOB_STATE_RUNNING", "JOB_STATE_SUCCEEDED", "JOB_STATE_FAILED", "JOB_STATE_CANCELLING", "JOB_STATE_CANCELLED", "JOB_STATE_PAUSED", "JOB_STATE_EXPIRED", "JOB_STATE_UPDATING", "JOB_STATE_PARTIALLY_SUCCEEDED" ], "enumDescriptions": [ "The job state is unspecified.", "The job has been just created or resumed and processing has not yet begun.", "The service is preparing to run the job.", "The job is in progress.", "The job completed successfully.", "The job failed.", "The job is being cancelled. From this state the job may only go to either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.", "The job has been cancelled.", "The job has been stopped, and can be resumed.", "The job has expired.", "The job is being updated. Only jobs in the `RUNNING` state can be updated. After updating, the job goes back to the `RUNNING` state.", "The job is partially succeeded, some results may be missing due to errors." ], "readOnly": true } }, "description": "Represents a model monitoring job that analyze dataset using different monitoring algorithm.", "type": "object", "id": "GoogleCloudAiplatformV1beta1ModelMonitoringJob" }, "GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsFilterTabularStatsFilter": { "description": "Tabular statistics filter.", "type": "object", "id": "GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsFilterTabularStatsFilter", "properties": { "objectiveType": { "description": "One of the supported monitoring objectives: `raw-feature-drift` `prediction-output-drift` `feature-attribution`", "type": "string" }, "modelMonitoringSchedule": { "description": "From a particular monitoring schedule.", "type": "string" }, "statsName": { "description": "If not specified, will return all the stats_names.", "type": "string" }, "algorithm": { "description": "Specify the algorithm type used for distance calculation, eg: jensen_shannon_divergence, l_infinity.", "type": "string" }, "modelMonitoringJob": { "description": "From a particular monitoring job.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1RagQuery": { "type": "object", "id": "GoogleCloudAiplatformV1beta1RagQuery", "description": "A query to retrieve relevant contexts.", "properties": { "text": { "description": "Optional. The query in text format to get relevant contexts.", "type": "string" }, "similarityTopK": { "description": "Optional. The number of contexts to retrieve.", "type": "integer", "format": "int32", "deprecated": true }, "ranking": { "$ref": "GoogleCloudAiplatformV1beta1RagQueryRanking", "deprecated": true, "description": "Optional. Configurations for hybrid search results ranking." }, "ragRetrievalConfig": { "description": "Optional. The retrieval config for the query.", "$ref": "GoogleCloudAiplatformV1beta1RagRetrievalConfig" } } }, "GenaiVertexV1beta1FileSearchResultContent": { "id": "GenaiVertexV1beta1FileSearchResultContent", "deprecated": true, "type": "object", "description": "File Search result content.", "properties": { "result": { "description": "The results of the File Search.", "type": "array", "items": { "$ref": "GenaiVertexV1beta1FileSearchResultContentFileSearchResult" } } } }, "GoogleCloudAiplatformV1beta1PauseScheduleRequest": { "type": "object", "description": "Request message for ScheduleService.PauseSchedule.", "properties": {}, "id": "GoogleCloudAiplatformV1beta1PauseScheduleRequest" }, "GoogleCloudAiplatformV1beta1ImportRagFilesRequest": { "type": "object", "description": "Request message for VertexRagDataService.ImportRagFiles.", "properties": { "importRagFilesConfig": { "description": "Required. The config for the RagFiles to be synced and imported into the RagCorpus. VertexRagDataService.ImportRagFiles.", "$ref": "GoogleCloudAiplatformV1beta1ImportRagFilesConfig" } }, "id": "GoogleCloudAiplatformV1beta1ImportRagFilesRequest" }, "GoogleCloudAiplatformV1beta1QuestionAnsweringQualityResult": { "id": "GoogleCloudAiplatformV1beta1QuestionAnsweringQualityResult", "properties": { "explanation": { "description": "Output only. Explanation for question answering quality score.", "readOnly": true, "type": "string" }, "score": { "type": "number", "readOnly": true, "description": "Output only. Question Answering Quality score.", "format": "float" }, "confidence": { "type": "number", "readOnly": true, "format": "float", "description": "Output only. Confidence for question answering quality score." } }, "type": "object", "description": "Spec for question answering quality result." }, "GoogleCloudAiplatformV1beta1ExportModelResponse": { "properties": {}, "type": "object", "description": "Response message of ModelService.ExportModel operation.", "id": "GoogleCloudAiplatformV1beta1ExportModelResponse" }, "GoogleCloudAiplatformV1beta1QueryReasoningEngineRequest": { "id": "GoogleCloudAiplatformV1beta1QueryReasoningEngineRequest", "properties": { "input": { "type": "object", "description": "Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "classMethod": { "description": "Optional. Class method to be used for the query. It is optional and defaults to \"query\" if unspecified.", "type": "string" } }, "type": "object", "description": "Request message for ReasoningEngineExecutionService.QueryReasoningEngine." }, "GoogleCloudAiplatformV1beta1AssessDataRequestTuningResourceUsageAssessmentConfig": { "description": "Configuration for the tuning resource usage assessment.", "type": "object", "id": "GoogleCloudAiplatformV1beta1AssessDataRequestTuningResourceUsageAssessmentConfig", "properties": { "modelName": { "description": "Required. The name of the model used for tuning.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1ListDataLabelingJobsResponse": { "properties": { "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "dataLabelingJobs": { "type": "array", "description": "A list of DataLabelingJobs that matches the specified filter in the request.", "items": { "$ref": "GoogleCloudAiplatformV1beta1DataLabelingJob" } } }, "type": "object", "description": "Response message for JobService.ListDataLabelingJobs.", "id": "GoogleCloudAiplatformV1beta1ListDataLabelingJobsResponse" }, "GoogleCloudAiplatformV1beta1TrialParameter": { "id": "GoogleCloudAiplatformV1beta1TrialParameter", "type": "object", "description": "A message representing a parameter to be tuned.", "properties": { "parameterId": { "description": "Output only. The ID of the parameter. The parameter should be defined in StudySpec's Parameters.", "type": "string", "readOnly": true }, "value": { "type": "any", "readOnly": true, "description": "Output only. The value of the parameter. `number_value` will be set if a parameter defined in StudySpec is in type 'INTEGER', 'DOUBLE' or 'DISCRETE'. `string_value` will be set if a parameter defined in StudySpec is in type 'CATEGORICAL'." } } }, "GoogleCloudAiplatformV1beta1ListSpecialistPoolsResponse": { "description": "Response message for SpecialistPoolService.ListSpecialistPools.", "id": "GoogleCloudAiplatformV1beta1ListSpecialistPoolsResponse", "properties": { "specialistPools": { "description": "A list of SpecialistPools that matches the specified filter in the request.", "items": { "$ref": "GoogleCloudAiplatformV1beta1SpecialistPool" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1CancelAsyncQueryReasoningEngineResponse": { "description": "Response message for ReasoningEngineExecutionService.CancelAsyncQueryReasoningEngine.", "properties": {}, "id": "GoogleCloudAiplatformV1beta1CancelAsyncQueryReasoningEngineResponse", "type": "object" }, "GoogleCloudAiplatformV1beta1FeatureValueMetadata": { "description": "Metadata of feature value.", "id": "GoogleCloudAiplatformV1beta1FeatureValueMetadata", "properties": { "generateTime": { "description": "Feature generation timestamp. Typically, it is provided by user at feature ingestion time. If not, feature store will use the system timestamp when the data is ingested into feature store. Legacy Feature Store: For streaming ingestion, the time, aligned by days, must be no older than five years (1825 days) and no later than one year (366 days) in the future.", "format": "google-datetime", "type": "string" } }, "type": "object" }, "CloudAiLargeModelsVisionSeamless": { "properties": { "tessellateHorizontal": { "description": "If true, the generated video will be tessellatable as a horizontal tessellation.", "type": "boolean" }, "tessellateVertical": { "description": "If true, the generated video will be tessellatable as a vertical tessellation.", "type": "boolean" }, "loop": { "description": "If true, the generated video will be loopable (seamless time looping).", "type": "boolean" } }, "type": "object", "id": "CloudAiLargeModelsVisionSeamless" }, "GoogleCloudAiplatformV1beta1PythonPackageSpec": { "type": "object", "id": "GoogleCloudAiplatformV1beta1PythonPackageSpec", "properties": { "pythonModule": { "description": "Required. The Python module name to run after installing the packages.", "type": "string" }, "packageUris": { "items": { "type": "string" }, "description": "Required. The Google Cloud Storage location of the Python package files which are the training program and its dependent packages. The maximum number of package URIs is 100.", "type": "array" }, "env": { "description": "Environment variables to be passed to the python module. Maximum limit is 100.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1EnvVar" } }, "args": { "type": "array", "description": "Command line arguments to be passed to the Python task.", "items": { "type": "string" } }, "executorImageUri": { "type": "string", "description": "Required. The URI of a container image in Artifact Registry that will run the provided Python package. Vertex AI provides a wide range of executor images with pre-installed packages to meet users' various use cases. See the list of [pre-built containers for training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). You must use an image from this list." } }, "description": "The spec of a Python packaged code." }, "GoogleCloudAiplatformV1beta1UserScenarioGenerationConfig": { "id": "GoogleCloudAiplatformV1beta1UserScenarioGenerationConfig", "type": "object", "description": "User scenario generation configuration.", "properties": { "simulationInstruction": { "description": "Optional. Simulation instruction to guide the user scenario generation.", "type": "string" }, "userScenarioCount": { "description": "Required. The number of user scenarios to generate. The maximum number of scenarios that can be generated is 100.", "type": "string", "format": "int64" }, "modelName": { "description": "Optional. The model name to use for generation. It can be model name, e.g. \"gemini-3-pro-preview\". or the fully qualified name of the publisher model or endpoint. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "type": "string" }, "environmentData": { "description": "Optional. Environment data in string type.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1BatchCreateTensorboardRunsRequest": { "description": "Request message for TensorboardService.BatchCreateTensorboardRuns.", "properties": { "requests": { "items": { "$ref": "GoogleCloudAiplatformV1beta1CreateTensorboardRunRequest" }, "description": "Required. The request message specifying the TensorboardRuns to create. A maximum of 1000 TensorboardRuns can be created in a batch.", "type": "array" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardRunsRequest" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs", "properties": { "sentimentMax": { "format": "int32", "description": "A sentiment is expressed as an integer ordinal, where higher value means a more positive sentiment. The range of sentiments that will be used is between 0 and sentimentMax (inclusive on both ends), and all the values in the range must be represented in the dataset before a model can be created. Only the Annotations with this sentimentMax will be used for training. sentimentMax value must be between 1 and 10 (inclusive).", "type": "integer" } } }, "GoogleCloudAiplatformV1beta1ListEventsResponse": { "id": "GoogleCloudAiplatformV1beta1ListEventsResponse", "description": "Response message for SessionService.ListEvents.", "properties": { "sessionEvents": { "items": { "$ref": "GoogleCloudAiplatformV1beta1SessionEvent" }, "type": "array", "description": "A list of events matching the request. Ordered by timestamp in ascending order." }, "nextPageToken": { "type": "string", "description": "A token, which can be sent as ListEventsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1WriteTensorboardRunDataRequest": { "type": "object", "id": "GoogleCloudAiplatformV1beta1WriteTensorboardRunDataRequest", "properties": { "tensorboardRun": { "type": "string", "description": "Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`" }, "timeSeriesData": { "description": "Required. The TensorboardTimeSeries data to write. Values with in a time series are indexed by their step value. Repeated writes to the same step will overwrite the existing value for that step. The upper limit of data points per write request is 5000.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1TimeSeriesData" } } }, "description": "Request message for TensorboardService.WriteTensorboardRunData." }, "GoogleCloudAiplatformV1beta1ReasoningEngineTrafficConfigTrafficSplitManualTarget": { "id": "GoogleCloudAiplatformV1beta1ReasoningEngineTrafficConfigTrafficSplitManualTarget", "description": "A single target for the traffic split, specifying a Runtime Revision and the percentage of traffic to send to it.", "type": "object", "properties": { "runtimeRevisionName": { "description": "Required. The Runtime Revision name to which to send this portion of traffic, if traffic allocation is by Runtime Revision.", "type": "string" }, "percent": { "description": "Required. Specifies percent of the traffic to this Runtime Revision.", "type": "integer", "format": "int32" } } }, "GoogleCloudAiplatformV1beta1GeminiTemplateConfig": { "properties": { "fieldMapping": { "additionalProperties": { "type": "string" }, "description": "Required. Map of template parameters to the columns in the dataset table.", "type": "object" }, "geminiExample": { "description": "Required. The template that will be used for assembling the request to use for downstream applications.", "$ref": "GoogleCloudAiplatformV1beta1GeminiExample" } }, "description": "Template configuration to create Gemini examples from a multimodal dataset.", "type": "object", "id": "GoogleCloudAiplatformV1beta1GeminiTemplateConfig" }, "GenaiVertexV1beta1ThoughtSummaryContent": { "properties": { "text": { "$ref": "GenaiVertexV1beta1TextContent" }, "image": { "$ref": "GenaiVertexV1beta1ImageContent" } }, "id": "GenaiVertexV1beta1ThoughtSummaryContent", "type": "object" }, "GoogleCloudAiplatformV1beta1AddContextChildrenResponse": { "description": "Response message for MetadataService.AddContextChildren.", "properties": {}, "type": "object", "id": "GoogleCloudAiplatformV1beta1AddContextChildrenResponse" }, "GenaiVertexV1beta1AntigravityAgentConfig": { "type": "object", "id": "GenaiVertexV1beta1AntigravityAgentConfig", "description": "Configuration for the Antigravity agent runtime. Provides server-side control over the agent's execution environment and tool configuration.", "properties": { "model": { "type": "string", "description": "The model to use for agent reasoning." }, "maxTotalTokens": { "description": "Max total tokens for the agent run.", "type": "string", "format": "int64" } } }, "GoogleTypeColor": { "properties": { "alpha": { "type": "number", "description": "The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).", "format": "float" }, "green": { "type": "number", "description": "The amount of green in the color as a value in the interval [0, 1].", "format": "float" }, "blue": { "format": "float", "description": "The amount of blue in the color as a value in the interval [0, 1].", "type": "number" }, "red": { "type": "number", "description": "The amount of red in the color as a value in the interval [0, 1].", "format": "float" } }, "id": "GoogleTypeColor", "type": "object", "description": "Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha \u003c= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i \u003c missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ..." }, "GoogleCloudAiplatformV1beta1CheckSignUpEligibilityResponse": { "type": "object", "description": "Response message for ExpressModeService.CheckSignUpEligibility.", "properties": { "eligibility": { "enumDescriptions": [ "The default value. This value is unused.", "The user is eligible to sign up for Vertex AI Express Mode.", "The user is in scope for Vertex AI Express Mode.", "The user is ineligible to sign up for Vertex AI Express Mode." ], "enum": [ "ELIGIBILITY_STATUS_UNSPECIFIED", "ELIGIBLE", "IN_SCOPE", "INELIGIBLE" ], "description": "The eligibility status of the user.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1CheckSignUpEligibilityResponse" }, "GoogleCloudAiplatformV1beta1StartNotebookRuntimeRequest": { "type": "object", "properties": {}, "description": "Request message for NotebookService.StartNotebookRuntime.", "id": "GoogleCloudAiplatformV1beta1StartNotebookRuntimeRequest" }, "GoogleCloudAiplatformV1beta1NasJob": { "description": "Represents a Neural Architecture Search (NAS) job.", "id": "GoogleCloudAiplatformV1beta1NasJob", "type": "object", "properties": { "state": { "type": "string", "description": "Output only. The detailed state of the job.", "enum": [ "JOB_STATE_UNSPECIFIED", "JOB_STATE_QUEUED", "JOB_STATE_PENDING", "JOB_STATE_RUNNING", "JOB_STATE_SUCCEEDED", "JOB_STATE_FAILED", "JOB_STATE_CANCELLING", "JOB_STATE_CANCELLED", "JOB_STATE_PAUSED", "JOB_STATE_EXPIRED", "JOB_STATE_UPDATING", "JOB_STATE_PARTIALLY_SUCCEEDED" ], "readOnly": true, "enumDescriptions": [ "The job state is unspecified.", "The job has been just created or resumed and processing has not yet begun.", "The service is preparing to run the job.", "The job is in progress.", "The job completed successfully.", "The job failed.", "The job is being cancelled. From this state the job may only go to either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.", "The job has been cancelled.", "The job has been stopped, and can be resumed.", "The job has expired.", "The job is being updated. Only jobs in the `RUNNING` state can be updated. After updating, the job goes back to the `RUNNING` state.", "The job is partially succeeded, some results may be missing due to errors." ] }, "startTime": { "readOnly": true, "description": "Output only. Time when the NasJob for the first time entered the `JOB_STATE_RUNNING` state.", "format": "google-datetime", "type": "string" }, "displayName": { "description": "Required. The display name of the NasJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "The labels with user-defined metadata to organize NasJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.", "type": "object" }, "updateTime": { "description": "Output only. Time when the NasJob was most recently updated.", "format": "google-datetime", "readOnly": true, "type": "string" }, "satisfiesPzs": { "readOnly": true, "description": "Output only. Reserved for future use.", "type": "boolean" }, "createTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. Time when the NasJob was created." }, "nasJobSpec": { "description": "Required. The specification of a NasJob.", "$ref": "GoogleCloudAiplatformV1beta1NasJobSpec" }, "encryptionSpec": { "description": "Customer-managed encryption key options for a NasJob. If this is set, then all resources created by the NasJob will be encrypted with the provided encryption key.", "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec" }, "error": { "$ref": "GoogleRpcStatus", "description": "Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.", "readOnly": true }, "name": { "readOnly": true, "type": "string", "description": "Output only. Resource name of the NasJob." }, "enableRestrictedImageTraining": { "description": "Optional. Enable a separation of Custom model training and restricted image training for tenant project.", "deprecated": true, "type": "boolean" }, "nasJobOutput": { "readOnly": true, "description": "Output only. Output of the NasJob.", "$ref": "GoogleCloudAiplatformV1beta1NasJobOutput" }, "satisfiesPzi": { "readOnly": true, "type": "boolean", "description": "Output only. Reserved for future use." }, "endTime": { "readOnly": true, "description": "Output only. Time when the NasJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.", "type": "string", "format": "google-datetime" } } }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingInputsTransformation": { "type": "object", "properties": { "numeric": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingInputsTransformationNumericTransformation" }, "text": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation" }, "categorical": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingInputsTransformationCategoricalTransformation" }, "auto": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingInputsTransformationAutoTransformation" }, "timestamp": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation" } }, "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingInputsTransformation" }, "GenaiVertexV1beta1ProcessingCallDelta": { "id": "GenaiVertexV1beta1ProcessingCallDelta", "description": "Streaming delta for a server-initiated media processing step.", "properties": {}, "type": "object" }, "GoogleCloudAiplatformV1beta1CountTokensResponse": { "properties": { "totalBillableCharacters": { "type": "integer", "format": "int32", "description": "The total number of billable characters counted across all instances from the request." }, "totalTokens": { "format": "int32", "description": "The total number of tokens counted across all instances from the request.", "type": "integer" }, "promptTokensDetails": { "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" }, "description": "Output only. List of modalities that were processed in the request input." } }, "type": "object", "description": "Response message for PredictionService.CountTokens.", "id": "GoogleCloudAiplatformV1beta1CountTokensResponse" }, "GoogleCloudAiplatformV1beta1EvaluationDataset": { "type": "object", "description": "The dataset used for evaluation.", "properties": { "gcsSource": { "$ref": "GoogleCloudAiplatformV1beta1GcsSource", "description": "Cloud storage source holds the dataset. Currently only one Cloud Storage file path is supported." }, "bigquerySource": { "description": "BigQuery source holds the dataset.", "$ref": "GoogleCloudAiplatformV1beta1BigQuerySource" } }, "id": "GoogleCloudAiplatformV1beta1EvaluationDataset" }, "GoogleCloudAiplatformV1beta1InternalOsServiceStateInstance": { "id": "GoogleCloudAiplatformV1beta1InternalOsServiceStateInstance", "description": "Request message for [InternalOsServiceStateInstance].", "type": "object", "properties": { "serviceName": { "type": "string", "enum": [ "INTERNAL_OS_SERVICE_ENUM_UNSPECIFIED", "DOCKER_SERVICE_STATE", "CONTROL_PLANE_API_DNS_STATE", "PROXY_REGISTRATION_DNS_STATE", "JUPYTER_STATE", "JUPYTER_API_STATE", "EUC_METADATA_API_STATE", "EUC_AGENT_API_STATE", "IDLE_SHUTDOWN_AGENT_STATE", "PROXY_AGENT_STATE", "GCR_DNS_STATE", "GUEST_ATTRIBUTE_STATE" ], "description": "Required. internal service name.", "enumDescriptions": [ "Service name unknown.", "Represents the internal os docker client.", "Represents resolving DNS for the control plane api endpoint.", "Represents resolving DNS for the proxy registration endpoint.", "Represents the jupyter endpoint.", "Represents the jupyter/api endpoint.", "Represents the EUC metadata server API endpoint.", "Represents the EUC agent server API endpoint.", "Represents the idle shutdown agent sidecar container.", "Represents the proxy agent sidecar container.", "Represents resolving DNS for the gcr.io endpoint.", "Represents if the guest attribute service is enabled." ] }, "serviceState": { "description": "Required. internal service state.", "enum": [ "UNKNOWN", "HEALTHY", "UNHEALTHY" ], "type": "string", "enumDescriptions": [ "Health status is unknown: not initialized or failed to retrieve.", "The resource is healthy.", "The resource is unhealthy." ] } } }, "GoogleCloudAiplatformV1beta1RetrievalConfig": { "type": "object", "properties": { "languageCode": { "type": "string", "description": "The language code of the user." }, "latLng": { "description": "The location of the user.", "$ref": "GoogleTypeLatLng" } }, "id": "GoogleCloudAiplatformV1beta1RetrievalConfig", "description": "Retrieval config." }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextSentiment": { "type": "object", "properties": { "inputs": { "description": "The input parameters of this TrainingJob.", "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextSentimentInputs" } }, "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextSentiment", "description": "A TrainingJob that trains and uploads an AutoML Text Sentiment Model." }, "GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsResponse": { "properties": { "nextPageToken": { "description": "The page token that can be used by the next ModelMonitoringService.SearchModelMonitoringStats call.", "type": "string" }, "monitoringStats": { "items": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringStats" }, "type": "array", "description": "Stats retrieved for requested objectives." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsResponse", "description": "Response message for ModelMonitoringService.SearchModelMonitoringStats." }, "GoogleCloudAiplatformV1beta1FulfillmentInstance": { "properties": { "prediction": { "type": "string", "description": "Required. Output of the evaluated model." }, "instruction": { "type": "string", "description": "Required. Inference instruction prompt to compare prediction with." } }, "description": "Spec for fulfillment instance.", "type": "object", "id": "GoogleCloudAiplatformV1beta1FulfillmentInstance" }, "GoogleCloudAiplatformV1beta1RagManagedDbConfigBasic": { "description": "Basic tier is a cost-effective and low compute tier suitable for the following cases: * Experimenting with RagManagedDb. * Small data size. * Latency insensitive workload. * Only using RAG Engine with external vector DBs. NOTE: This is the default tier under Spanner mode if not explicitly chosen.", "properties": {}, "type": "object", "id": "GoogleCloudAiplatformV1beta1RagManagedDbConfigBasic" }, "GoogleCloudAiplatformV1beta1EvaluationRunMetric": { "type": "object", "id": "GoogleCloudAiplatformV1beta1EvaluationRunMetric", "properties": { "computationBasedMetricSpec": { "description": "Spec for a computation based metric.", "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunMetricComputationBasedMetricSpec" }, "metricResourceName": { "type": "string", "description": "Optional. The resource name of the metric definition." }, "predefinedMetricSpec": { "description": "Spec for a pre-defined metric.", "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunMetricPredefinedMetricSpec" }, "metric": { "description": "Required. The name of the metric.", "type": "string" }, "rubricBasedMetricSpec": { "description": "Spec for rubric based metric.", "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunMetricRubricBasedMetricSpec" }, "metricConfig": { "$ref": "GoogleCloudAiplatformV1beta1Metric", "description": "The metric config." }, "llmBasedMetricSpec": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunMetricLLMBasedMetricSpec", "description": "Spec for an LLM based metric." } }, "description": "The metric used for evaluation runs." }, "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics": { "type": "object", "properties": { "recall": { "format": "float", "description": "Recall (True Positive Rate) for the given confidence threshold.", "type": "number" }, "f1Score": { "format": "float", "description": "The harmonic mean of recall and precision.", "type": "number" }, "precision": { "format": "float", "description": "Precision for the given confidence threshold.", "type": "number" }, "confidenceThreshold": { "type": "number", "description": "Metrics are computed with an assumption that the Model never returns predictions with score lower than this value.", "format": "float" } }, "id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics" }, "GoogleCloudAiplatformV1beta1ExplanationMetadataOverrideInputMetadataOverride": { "properties": { "inputBaselines": { "items": { "type": "any" }, "type": "array", "description": "Baseline inputs for this feature. This overrides the `input_baseline` field of the ExplanationMetadata.InputMetadata object of the corresponding feature's input metadata. If it's not specified, the original baselines are not overridden." } }, "id": "GoogleCloudAiplatformV1beta1ExplanationMetadataOverrideInputMetadataOverride", "description": "The input metadata entries to be overridden.", "type": "object" }, "GoogleCloudAiplatformV1beta1CheckTrialEarlyStoppingStateMetatdata": { "type": "object", "id": "GoogleCloudAiplatformV1beta1CheckTrialEarlyStoppingStateMetatdata", "properties": { "study": { "description": "The name of the Study that the Trial belongs to.", "type": "string" }, "trial": { "description": "The Trial name.", "type": "string" }, "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "Operation metadata for suggesting Trials." } }, "description": "This message will be placed in the metadata field of a google.longrunning.Operation associated with a CheckTrialEarlyStoppingState request." }, "GoogleCloudAiplatformV1beta1FilterSplit": { "description": "Assigns input data to training, validation, and test sets based on the given filters, data pieces not matched by any filter are ignored. Currently only supported for Datasets containing DataItems. If any of the filters in this message are to match nothing, then they can be set as '-' (the minus sign). Supported only for unstructured Datasets. ", "properties": { "testFilter": { "type": "string", "description": "Required. A filter on DataItems of the Dataset. DataItems that match this filter are used to test the Model. A filter with same syntax as the one used in DatasetService.ListDataItems may be used. If a single DataItem is matched by more than one of the FilterSplit filters, then it is assigned to the first set that applies to it in the training, validation, test order." }, "validationFilter": { "type": "string", "description": "Required. A filter on DataItems of the Dataset. DataItems that match this filter are used to validate the Model. A filter with same syntax as the one used in DatasetService.ListDataItems may be used. If a single DataItem is matched by more than one of the FilterSplit filters, then it is assigned to the first set that applies to it in the training, validation, test order." }, "trainingFilter": { "description": "Required. A filter on DataItems of the Dataset. DataItems that match this filter are used to train the Model. A filter with same syntax as the one used in DatasetService.ListDataItems may be used. If a single DataItem is matched by more than one of the FilterSplit filters, then it is assigned to the first set that applies to it in the training, validation, test order.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1FilterSplit", "type": "object" }, "GoogleCloudAiplatformV1beta1ListEvaluationRunsResponse": { "description": "Response message for EvaluationManagementService.ListEvaluationRuns.", "properties": { "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results." }, "evaluationRuns": { "type": "array", "description": "List of EvaluationRuns in the requested page.", "items": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationRun" } } }, "id": "GoogleCloudAiplatformV1beta1ListEvaluationRunsResponse", "type": "object" }, "GoogleCloudAiplatformV1beta1Agent": { "type": "object", "id": "GoogleCloudAiplatformV1beta1Agent", "description": "A Vertex agent contains instructions and configurations for the LLM to execute a certain task.", "properties": { "tools": { "description": "Optional. The tools available to the agent.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1AgentTool" } }, "base_environment": { "type": "any", "description": "Optional. The base environment configuration for the agent. Valid types: * A string value for the environment ID, or `remote` for the default. * A struct value for the `environment_config`." }, "id": { "description": "Immutable. The user-specified ID for the agent. This ID becomes the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. The ID can be up to 63 characters and must match the regular expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`.", "type": "string" }, "name": { "description": "Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.", "type": "string" }, "description": { "type": "string", "description": "Optional. The description of the agent." }, "object": { "readOnly": true, "type": "string", "description": "Output only. The object type of the resource. For agents, the value is `agent`." }, "system_instruction": { "description": "Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction.", "type": "string" }, "metadata": { "description": "Optional. The metadata for the agent.", "additionalProperties": { "type": "string" }, "type": "object" }, "created": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The time the agent was created." }, "base_agent": { "description": "Required. Immutable. The base agent for the agent. Supported values: * `antigravity-preview-05-2026` Immutable: `UpdateAgent` rejects a change, including clearing it. The kind of agent this is gets derived from this field when the agent is created and is recorded then; nothing recomputes it afterwards, so a later change would leave the agent described as one kind and behaving as another. Create a new agent instead.", "type": "string" }, "updated": { "description": "Output only. The time the agent was last updated.", "format": "google-datetime", "type": "string", "readOnly": true } } }, "GoogleCloudAiplatformV1beta1CreateNotebookExecutionJobRequest": { "properties": { "parent": { "type": "string", "description": "Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`" }, "notebookExecutionJob": { "$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJob", "description": "Required. The NotebookExecutionJob to create." }, "notebookExecutionJobId": { "type": "string", "description": "Optional. User specified ID for the NotebookExecutionJob." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1CreateNotebookExecutionJobRequest", "description": "Request message for [NotebookService.CreateNotebookExecutionJob]" }, "GoogleCloudAiplatformV1beta1GenerateVideoResponseVideo": { "description": "A generated video.", "type": "object", "properties": { "gcsUri": { "type": "string", "description": "Cloud Storage URI where the generated video is written." }, "mimeType": { "type": "string", "description": "The MIME type of the content of the video. - video/mp4" }, "bytesBase64Encoded": { "description": "Base64 encoded bytes string representing the video.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1GenerateVideoResponseVideo" }, "GoogleCloudAiplatformV1beta1LustreMount": { "id": "GoogleCloudAiplatformV1beta1LustreMount", "type": "object", "properties": { "filesystem": { "type": "string", "description": "Required. The name of the Lustre filesystem." }, "volumeHandle": { "description": "Required. The unique identifier of the Lustre volume.", "type": "string" }, "instanceIp": { "type": "string", "description": "Required. IP address of the Lustre instance." }, "mountPoint": { "description": "Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/", "type": "string" } }, "description": "Represents a mount configuration for Lustre file system." }, "GoogleCloudAiplatformV1beta1SchemaTextSentimentAnnotation": { "properties": { "sentiment": { "format": "int32", "description": "The sentiment score for text.", "type": "integer" }, "annotationSpecId": { "description": "The resource Id of the AnnotationSpec that this Annotation pertains to.", "type": "string" }, "displayName": { "type": "string", "description": "The display name of the AnnotationSpec that this Annotation pertains to." }, "sentimentMax": { "type": "integer", "format": "int32", "description": "The sentiment max score for text." } }, "description": "Annotation details specific to text sentiment.", "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaTextSentimentAnnotation" }, "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployGke": { "type": "object", "properties": { "gkeYamlConfigs": { "description": "Optional. GKE deployment configuration in yaml format.", "type": "array", "items": { "type": "string" } } }, "id": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployGke", "description": "Configurations for PublisherModel GKE deployment" }, "GoogleCloudAiplatformV1beta1OnlineEvaluatorConfigRandomSampling": { "type": "object", "properties": { "percentage": { "format": "int32", "description": "Required. The percentage of traces to sample for evaluation. Must be an integer between `1` and `100`.", "type": "integer" } }, "id": "GoogleCloudAiplatformV1beta1OnlineEvaluatorConfigRandomSampling", "description": "Configuration for random sampling." }, "GoogleCloudAiplatformV1beta1ListExtensionsResponse": { "type": "object", "description": "Response message for ExtensionRegistryService.ListExtensions", "properties": { "nextPageToken": { "description": "A token to retrieve the next page of results. Pass to ListExtensionsRequest.page_token to obtain that page.", "type": "string" }, "extensions": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Extension" }, "description": "List of Extension in the requested page.", "type": "array" } }, "id": "GoogleCloudAiplatformV1beta1ListExtensionsResponse" }, "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponseFeatureNameValuePairList": { "id": "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponseFeatureNameValuePairList", "properties": { "features": { "items": { "$ref": "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair" }, "type": "array", "description": "List of feature names and values." } }, "description": "Response structure in the format of key (feature name) and (feature) value pair.", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageSegmentation": { "properties": { "metadata": { "description": "The metadata information.", "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageSegmentationMetadata" }, "inputs": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs", "description": "The input parameters of this TrainingJob." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageSegmentation", "description": "A TrainingJob that trains and uploads an AutoML Image Segmentation Model." }, "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics", "properties": { "falsePositiveRateAt1": { "type": "number", "format": "float", "description": "The False Positive Rate when only considering the label that has the highest prediction score and not below the confidence threshold for each DataItem." }, "recall": { "format": "float", "type": "number", "description": "Recall (True Positive Rate) for the given confidence threshold." }, "confusionMatrix": { "description": "Confusion matrix of the evaluation for this confidence_threshold.", "$ref": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsConfusionMatrix" }, "truePositiveCount": { "format": "int64", "description": "The number of Model created labels that match a ground truth label.", "type": "string" }, "trueNegativeCount": { "format": "int64", "description": "The number of labels that were not created by the Model, but if they would, they would not match a ground truth label.", "type": "string" }, "f1ScoreAt1": { "format": "float", "description": "The harmonic mean of recallAt1 and precisionAt1.", "type": "number" }, "precision": { "format": "float", "type": "number", "description": "Precision for the given confidence threshold." }, "falsePositiveCount": { "description": "The number of Model created labels that do not match a ground truth label.", "type": "string", "format": "int64" }, "f1Score": { "description": "The harmonic mean of recall and precision. For summary metrics, it computes the micro-averaged F1 score.", "type": "number", "format": "float" }, "precisionAt1": { "type": "number", "format": "float", "description": "The precision when only considering the label that has the highest prediction score and not below the confidence threshold for each DataItem." }, "f1ScoreMicro": { "type": "number", "description": "Micro-averaged F1 Score.", "format": "float" }, "maxPredictions": { "format": "int32", "description": "Metrics are computed with an assumption that the Model always returns at most this many predictions (ordered by their score, descendingly), but they all still need to meet the `confidenceThreshold`.", "type": "integer" }, "falseNegativeCount": { "description": "The number of ground truth labels that are not matched by a Model created label.", "type": "string", "format": "int64" }, "recallAt1": { "type": "number", "description": "The Recall (True Positive Rate) when only considering the label that has the highest prediction score and not below the confidence threshold for each DataItem.", "format": "float" }, "falsePositiveRate": { "type": "number", "description": "False Positive Rate for the given confidence threshold.", "format": "float" }, "f1ScoreMacro": { "type": "number", "format": "float", "description": "Macro-averaged F1 Score." }, "confidenceThreshold": { "type": "number", "description": "Metrics are computed with an assumption that the Model never returns predictions with score lower than this value.", "format": "float" } } }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputs", "properties": { "transformations": { "type": "array", "description": "Each transformation will apply transform function to given input column. And the result will be used for training. When creating transformation for BigQuery Struct column, the column should be flattened using \".\" as the delimiter.", "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation" } }, "hierarchyConfig": { "description": "Configuration that defines the hierarchical relationship of time series and parameters for hierarchical forecasting strategies.", "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionHierarchyConfig" }, "timeSeriesAttributeColumns": { "type": "array", "items": { "type": "string" }, "description": "Column names that should be used as attribute columns. The value of these columns does not vary as a function of time. For example, store ID or item color." }, "trainBudgetMilliNodeHours": { "type": "string", "description": "Required. The train budget of creating this model, expressed in milli node hours i.e. 1,000 value in this field means 1 node hour. The training cost of the model will not exceed this budget. The final cost will be attempted to be close to the budget, though may end up being (even) noticeably smaller - at the backend's discretion. This especially may happen when further model training ceases to provide any improvements. If the budget is set to a value known to be insufficient to train a model for the given dataset, the training won't be attempted and will error. The train budget must be between 1,000 and 72,000 milli node hours, inclusive.", "format": "int64" }, "exportEvaluatedDataItemsConfig": { "description": "Configuration for exporting test set predictions to a BigQuery table. If this configuration is absent, then the export is not performed.", "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig" }, "forecastHorizon": { "description": "The amount of time into the future for which forecasted values for the target are returned. Expressed in number of units defined by the `data_granularity` field.", "format": "int64", "type": "string" }, "quantiles": { "type": "array", "description": "Quantiles to use for minimize-quantile-loss `optimization_objective`. Up to 5 quantiles are allowed of values between 0 and 1, exclusive. Required if the value of optimization_objective is minimize-quantile-loss. Represents the percent quantiles to use for that objective. Quantiles must be unique.", "items": { "format": "double", "type": "number" } }, "targetColumn": { "type": "string", "description": "The name of the column that the Model is to predict values for. This column must be unavailable at forecast." }, "availableAtForecastColumns": { "description": "Names of columns that are available and provided when a forecast is requested. These columns contain information for the given entity (identified by the time_series_identifier_column column) that is known at forecast. For example, predicted weather for a specific day.", "items": { "type": "string" }, "type": "array" }, "unavailableAtForecastColumns": { "description": "Names of columns that are unavailable when a forecast is requested. This column contains information for the given entity (identified by the time_series_identifier_column) that is unknown before the forecast For example, actual weather on a given day.", "items": { "type": "string" }, "type": "array" }, "weightColumn": { "type": "string", "description": "Column name that should be used as the weight column. Higher values in this column give more importance to the row during model training. The column must have numeric values between 0 and 10000 inclusively; 0 means the row is ignored for training. If weight column field is not set, then all rows are assumed to have equal weight of 1. This column must be available at forecast." }, "timeSeriesIdentifierColumn": { "description": "The name of the column that identifies the time series.", "type": "string" }, "validationOptions": { "type": "string", "description": "Validation options for the data validation component. The available options are: * \"fail-pipeline\" - default, will validate against the validation and fail the pipeline if it fails. * \"ignore-validation\" - ignore the results of the validation and continue" }, "additionalExperiments": { "items": { "type": "string" }, "description": "Additional experiment flags for the time series forcasting training.", "type": "array" }, "windowConfig": { "description": "Config containing strategy for generating sliding windows.", "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionWindowConfig" }, "timeColumn": { "type": "string", "description": "The name of the column that identifies time order in the time series. This column must be available at forecast." }, "dataGranularity": { "description": "Expected difference in time granularity between rows in the data.", "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity" }, "optimizationObjective": { "type": "string", "description": "Objective function the model is optimizing towards. The training process creates a model that optimizes the value of the objective function over the validation set. The supported optimization objectives: * \"minimize-rmse\" (default) - Minimize root-mean-squared error (RMSE). * \"minimize-mae\" - Minimize mean-absolute error (MAE). * \"minimize-rmsle\" - Minimize root-mean-squared log error (RMSLE). * \"minimize-rmspe\" - Minimize root-mean-squared percentage error (RMSPE). * \"minimize-wape-mae\" - Minimize the combination of weighted absolute percentage error (WAPE) and mean-absolute-error (MAE). * \"minimize-quantile-loss\" - Minimize the quantile loss at the quantiles defined in `quantiles`. * \"minimize-mape\" - Minimize the mean absolute percentage error." }, "holidayRegions": { "description": "The geographical region based on which the holiday effect is applied in modeling by adding holiday categorical array feature that include all holidays matching the date. This option only allowed when data_granularity is day. By default, holiday effect modeling is disabled. To turn it on, specify the holiday region using this option.", "type": "array", "items": { "type": "string" } }, "contextWindow": { "description": "The amount of time into the past training and prediction data is used for model training and prediction respectively. Expressed in number of units defined by the `data_granularity` field.", "type": "string", "format": "int64" } } }, "GoogleCloudAiplatformV1beta1FullFineTunedResources": { "id": "GoogleCloudAiplatformV1beta1FullFineTunedResources", "description": "Resources for an fft model.", "properties": { "deploymentType": { "enum": [ "DEPLOYMENT_TYPE_UNSPECIFIED", "DEPLOYMENT_TYPE_EVAL", "DEPLOYMENT_TYPE_PROD" ], "enumDescriptions": [ "Unspecified deployment type.", "Eval deployment type.", "Prod deployment type." ], "description": "Required. The kind of deployment.", "type": "string" }, "modelInferenceUnitCount": { "description": "Optional. The number of model inference units to use for this deployment. This can only be specified for DEPLOYMENT_TYPE_PROD. The following table lists the number of model inference units for different model types: * Gemini 2.5 Flash * Foundation FMIU: 25 * Expansion FMIU: 4 * Gemini 2.5 Pro * Foundation FMIU: 32 * Expansion FMIU: 16 * Veo 3.0 (undistilled) * Foundation FMIU: 63 * Expansion FMIU: 7 * Veo 3.0 (distilled) * Foundation FMIU: 30 * Expansion FMIU: 10", "format": "int32", "type": "integer" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation": { "type": "object", "properties": { "categorical": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationCategoricalTransformation" }, "timestamp": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation" }, "numeric": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation" }, "text": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation" }, "auto": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationAutoTransformation" } }, "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformation" }, "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteResponseWriteResponse": { "description": "Details about the write for each key.", "properties": { "dataKey": { "description": "What key is this write response associated with.", "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDataKey" }, "onlineStoreWriteTime": { "description": "When the feature values were written to the online store. If FeatureViewDirectWriteResponse.status is not OK, this field is not populated.", "type": "string", "format": "google-datetime" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteResponseWriteResponse" }, "GoogleCloudAiplatformV1beta1SampleConfig": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SampleConfig", "properties": { "followingBatchSamplePercentage": { "format": "int32", "type": "integer", "description": "The percentage of data needed to be labeled in each following batch (except the first batch)." }, "sampleStrategy": { "description": "Field to choose sampling strategy. Sampling strategy will decide which data should be selected for human labeling in every batch.", "enum": [ "SAMPLE_STRATEGY_UNSPECIFIED", "UNCERTAINTY" ], "enumDescriptions": [ "Default will be treated as UNCERTAINTY.", "Sample the most uncertain data to label." ], "type": "string" }, "initialBatchSamplePercentage": { "type": "integer", "format": "int32", "description": "The percentage of data needed to be labeled in the first batch." } }, "description": "Active learning data sampling config. For every active learning labeling iteration, it will select a batch of data based on the sampling strategy." }, "GoogleCloudAiplatformV1beta1RagManagedDbConfigEnterprise": { "id": "GoogleCloudAiplatformV1beta1RagManagedDbConfigEnterprise", "description": "Enterprise tier offers production grade performance along with autoscaling functionality. It is suitable for customers with large amounts of data or performance sensitive workloads.", "type": "object", "properties": {}, "deprecated": true }, "GenaiVertexV1beta1Value": { "description": "`Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.", "properties": { "listValue": { "description": "Represents a repeated `Value`.", "$ref": "GenaiVertexV1beta1ListValue" }, "numberValue": { "type": "number", "format": "double", "description": "Represents a double value." }, "stringValue": { "description": "Represents a string value.", "type": "string" }, "nullValue": { "enumDescriptions": [ "Null value." ], "description": "Represents a null value.", "enum": [ "NULL_VALUE" ], "type": "string" }, "boolValue": { "description": "Represents a boolean value.", "type": "boolean" }, "structValue": { "$ref": "GenaiVertexV1beta1Struct", "description": "Represents a structured value." }, "contentValue": { "description": "Represents rich content (text, image, etc.).", "$ref": "GenaiVertexV1beta1Content" } }, "type": "object", "id": "GenaiVertexV1beta1Value" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation": { "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation", "properties": { "columnName": { "type": "string" } }, "description": "Training pipeline will perform following transformation functions. * The categorical string as is--no change to case, punctuation, spelling, tense, and so on. * Convert the category name to a dictionary lookup index and generate an embedding for each index. * Categories that appear less than 5 times in the training dataset are treated as the \"unknown\" category. The \"unknown\" category gets its own special lookup index and resulting embedding.", "type": "object" }, "GoogleCloudAiplatformV1beta1RagRetrievalConfigHybridSearch": { "type": "object", "id": "GoogleCloudAiplatformV1beta1RagRetrievalConfigHybridSearch", "properties": { "alpha": { "format": "float", "type": "number", "description": "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." } }, "description": "Config for Hybrid Search." }, "GoogleCloudAiplatformV1beta1SupervisedTuningDataStats": { "description": "Tuning data statistics for Supervised Tuning.", "properties": { "tuningDatasetExampleCount": { "readOnly": true, "format": "int64", "type": "string", "description": "Output only. Number of examples in the tuning dataset." }, "userMessagePerExampleDistribution": { "description": "Output only. Dataset distributions for the messages per example.", "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1SupervisedTuningDatasetDistribution" }, "totalTruncatedExampleCount": { "type": "string", "readOnly": true, "description": "Output only. The number of examples in the dataset that have been dropped. An example can be dropped for reasons including: too many tokens, contains an invalid image, contains too many images, etc.", "format": "int64" }, "userOutputTokenDistribution": { "$ref": "GoogleCloudAiplatformV1beta1SupervisedTuningDatasetDistribution", "readOnly": true, "description": "Output only. Dataset distributions for the user output tokens." }, "userInputTokenDistribution": { "$ref": "GoogleCloudAiplatformV1beta1SupervisedTuningDatasetDistribution", "description": "Output only. Dataset distributions for the user input tokens.", "readOnly": true }, "truncatedExampleIndices": { "type": "array", "items": { "type": "string", "format": "int64" }, "description": "Output only. A partial sample of the indices (starting from 1) of the dropped examples.", "readOnly": true }, "droppedExampleReasons": { "type": "array", "readOnly": true, "items": { "type": "string" }, "description": "Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped." }, "totalBillableTokenCount": { "type": "string", "description": "Output only. Number of billable tokens in the tuning dataset.", "format": "int64", "readOnly": true }, "tuningStepCount": { "type": "string", "description": "Output only. Number of tuning steps for this Tuning Job.", "readOnly": true, "format": "int64" }, "totalTuningCharacterCount": { "description": "Output only. Number of tuning characters in the tuning dataset.", "readOnly": true, "format": "int64", "type": "string" }, "totalBillableCharacterCount": { "description": "Output only. Number of billable characters in the tuning dataset.", "format": "int64", "deprecated": true, "type": "string", "readOnly": true }, "userDatasetExamples": { "description": "Output only. Sample user messages in the training dataset uri.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" }, "readOnly": true } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SupervisedTuningDataStats" }, "GoogleCloudAiplatformV1beta1VideoMetadata": { "type": "object", "description": "Provides metadata for a video, including the start and end offsets for clipping and the frame rate.", "id": "GoogleCloudAiplatformV1beta1VideoMetadata", "properties": { "fps": { "type": "number", "format": "double", "description": "Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]." }, "startOffset": { "description": "Optional. The start offset of the video.", "type": "string", "format": "google-duration" }, "endOffset": { "description": "Optional. The end offset of the video.", "type": "string", "format": "google-duration" } } }, "GoogleCloudAiplatformV1beta1ExportFeatureValuesRequestFullExport": { "id": "GoogleCloudAiplatformV1beta1ExportFeatureValuesRequestFullExport", "type": "object", "properties": { "endTime": { "format": "google-datetime", "description": "Exports Feature values as of this timestamp. If not set, retrieve values as of now. Timestamp, if present, must not have higher than millisecond precision.", "type": "string" }, "startTime": { "description": "Excludes Feature values with feature generation timestamp before this timestamp. If not set, retrieve oldest values kept in Feature Store. Timestamp, if present, must not have higher than millisecond precision.", "type": "string", "format": "google-datetime" } }, "description": "Describes exporting all historical Feature values of all entities of the EntityType between [start_time, end_time]." }, "GoogleCloudAiplatformV1beta1StartNotebookRuntimeOperationMetadata": { "id": "GoogleCloudAiplatformV1beta1StartNotebookRuntimeOperationMetadata", "type": "object", "properties": { "progressMessage": { "type": "string", "description": "A human-readable message that shows the intermediate progress details of NotebookRuntime." }, "genericMetadata": { "description": "The operation generic information.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "description": "Metadata information for NotebookService.StartNotebookRuntime." }, "GoogleCloudAiplatformV1beta1ImportIndexRequestConnectorConfigBigQuerySourceConfig": { "description": "Configuration for importing data from a BigQuery table.", "type": "object", "id": "GoogleCloudAiplatformV1beta1ImportIndexRequestConnectorConfigBigQuerySourceConfig", "properties": { "tablePath": { "description": "Required. The path to the BigQuery table containing the index data, in the format of `bq://..`.", "type": "string" }, "datapointFieldMapping": { "description": "Required. Mapping of datapoint fields to BigQuery column names.", "$ref": "GoogleCloudAiplatformV1beta1ImportIndexRequestConnectorConfigDatapointFieldMapping" } } }, "GoogleCloudAiplatformV1beta1Int64Array": { "properties": { "values": { "items": { "type": "string", "format": "int64" }, "type": "array", "description": "A list of int64 values." } }, "type": "object", "description": "A list of int64 values.", "id": "GoogleCloudAiplatformV1beta1Int64Array" }, "GoogleCloudAiplatformV1beta1SandboxEnvironmentSpec": { "properties": { "computerUseEnvironment": { "description": "Optional. The computer use environment.", "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentSpecComputerUseEnvironment" }, "codeExecutionEnvironment": { "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentSpecCodeExecutionEnvironment", "description": "Optional. The code execution environment." }, "useGkeTd": { "type": "boolean", "description": "Optional. Immutable. Whether to provision the SandboxEnvironment via the GKE TD pool. Immutable." }, "shellEnvironment": { "description": "Optional. The shell environment for executing shell commands and scripts.", "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentSpecShellEnvironment" } }, "id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentSpec", "type": "object", "description": "The specification of a SandboxEnvironment." }, "GoogleCloudAiplatformV1beta1Schema": { "description": "Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object).", "properties": { "items": { "description": "Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.", "$ref": "GoogleCloudAiplatformV1beta1Schema" }, "properties": { "description": "Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1Schema" } }, "minimum": { "type": "number", "description": "Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.", "format": "double" }, "default": { "type": "any", "description": "Optional. Default value to use if the field is not specified." }, "minProperties": { "type": "string", "format": "int64", "description": "Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided." }, "pattern": { "type": "string", "description": "Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match." }, "maxLength": { "format": "int64", "type": "string", "description": "Optional. If type is `STRING`, `max_length` specifies the maximum length of the string." }, "format": { "description": "Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.", "type": "string" }, "maxItems": { "format": "int64", "description": "Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.", "type": "string" }, "minLength": { "format": "int64", "description": "Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.", "type": "string" }, "nullable": { "type": "boolean", "description": "Optional. Indicates if the value of this field can be null." }, "additionalProperties": { "type": "any", "description": "Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema." }, "anyOf": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Schema" }, "type": "array", "description": "Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`." }, "maximum": { "description": "Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.", "format": "double", "type": "number" }, "description": { "type": "string", "description": "Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt." }, "ref": { "description": "Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `defs`. For example, the following schema defines a reference to a schema node named \"Pet\": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the \"pet\" property is a reference to the schema node named \"Pet\". See details in https://json-schema.org/understanding-json-schema/structuring", "type": "string" }, "propertyOrdering": { "items": { "type": "string" }, "type": "array", "description": "Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties." }, "required": { "type": "array", "description": "Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.", "items": { "type": "string" } }, "type": { "type": "string", "enumDescriptions": [ "Not specified, should not be used.", "OpenAPI string type", "OpenAPI number type", "OpenAPI integer type", "OpenAPI boolean type", "OpenAPI array type", "OpenAPI object type", "Null type" ], "enum": [ "TYPE_UNSPECIFIED", "STRING", "NUMBER", "INTEGER", "BOOLEAN", "ARRAY", "OBJECT", "NULL" ], "description": "Optional. Data type of the schema field." }, "maxProperties": { "description": "Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.", "format": "int64", "type": "string" }, "example": { "description": "Optional. Example of an instance of this schema.", "type": "any" }, "enum": { "items": { "type": "string" }, "type": "array", "description": "Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:[\"EAST\", \"NORTH\", \"SOUTH\", \"WEST\"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:[\"101\", \"201\", \"301\"]}`" }, "defs": { "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1Schema" }, "type": "object", "description": "Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema." }, "title": { "description": "Optional. Title for the schema.", "type": "string" }, "minItems": { "type": "string", "format": "int64", "description": "Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1Schema" }, "GoogleCloudAiplatformV1beta1Trajectory": { "type": "object", "properties": { "toolCalls": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1ToolCall" }, "description": "Required. Tool calls in the trajectory." } }, "description": "Spec for trajectory.", "id": "GoogleCloudAiplatformV1beta1Trajectory" }, "GenaiVertexV1beta1McpServer": { "properties": { "allowedTools": { "type": "array", "description": "The allowed tools.", "items": { "$ref": "GenaiVertexV1beta1AllowedTools" } }, "url": { "description": "The full URL for the MCPServer endpoint. Example: \"https://api.example.com/mcp\"", "type": "string" }, "headers": { "description": "Optional: Fields for authentication headers, timeouts, etc., if needed.", "type": "object", "additionalProperties": { "type": "string" } }, "name": { "type": "string", "description": "The name of the MCPServer." } }, "description": "A MCPServer is a server that can be called by the model to perform actions.", "id": "GenaiVertexV1beta1McpServer", "type": "object" }, "GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigInputs": { "description": "Runtime inputs data of the task.", "properties": { "artifacts": { "type": "object", "description": "Optional. Input artifacts.", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigArtifactList" } }, "parameterValues": { "additionalProperties": { "type": "any" }, "type": "object", "description": "Optional. Input parameters." } }, "id": "GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigInputs", "type": "object" }, "GoogleCloudAiplatformV1beta1FlexStart": { "id": "GoogleCloudAiplatformV1beta1FlexStart", "description": "FlexStart is used to schedule the deployment workload on DWS resource. It contains the max duration of the deployment.", "type": "object", "properties": { "maxRuntimeDuration": { "description": "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.", "type": "string", "format": "google-duration" } } }, "GoogleCloudAiplatformV1beta1AddExecutionEventsRequest": { "type": "object", "id": "GoogleCloudAiplatformV1beta1AddExecutionEventsRequest", "properties": { "events": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Event" }, "type": "array", "description": "The Events to create and add." } }, "description": "Request message for MetadataService.AddExecutionEvents." }, "GoogleCloudAiplatformV1beta1RecommendSpecResponse": { "id": "GoogleCloudAiplatformV1beta1RecommendSpecResponse", "type": "object", "description": "Response message for ModelService.RecommendSpec.", "properties": { "specs": { "type": "array", "description": "Output only. The machine and model container specs.", "readOnly": true, "items": { "$ref": "GoogleCloudAiplatformV1beta1RecommendSpecResponseMachineAndModelContainerSpec" } }, "baseModel": { "description": "Output only. The base model used to finetune the custom model.", "type": "string", "readOnly": true }, "recommendations": { "items": { "$ref": "GoogleCloudAiplatformV1beta1RecommendSpecResponseRecommendation" }, "type": "array", "description": "Output only. Recommendations of deployment options for the given custom weights model.", "readOnly": true } } }, "GoogleCloudAiplatformV1beta1DeployedIndexAuthConfigAuthProvider": { "id": "GoogleCloudAiplatformV1beta1DeployedIndexAuthConfigAuthProvider", "properties": { "audiences": { "description": "The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted.", "items": { "type": "string" }, "type": "array" }, "allowedIssuers": { "description": "A list of allowed JWT issuers. Each entry must be a valid Google service account, in the following format: `service-account-name@project-id.iam.gserviceaccount.com`", "items": { "type": "string" }, "type": "array" } }, "description": "Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).", "type": "object" }, "GoogleCloudAiplatformV1beta1DeployRequest": { "id": "GoogleCloudAiplatformV1beta1DeployRequest", "description": "Request message for ModelGardenService.Deploy.", "type": "object", "properties": { "modelConfig": { "description": "Optional. The model config to use for the deployment. If not specified, the default model config will be used.", "$ref": "GoogleCloudAiplatformV1beta1DeployRequestModelConfig" }, "publisherModelName": { "type": "string", "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`." }, "huggingFaceModelId": { "description": "The Hugging Face model to deploy. Format: Hugging Face model ID like `google/gemma-2-2b-it`.", "type": "string" }, "customModel": { "$ref": "GoogleCloudAiplatformV1beta1DeployRequestCustomModel", "description": "The custom model to deploy from a Google Cloud Storage URI." }, "endpointConfig": { "$ref": "GoogleCloudAiplatformV1beta1DeployRequestEndpointConfig", "description": "Optional. The endpoint config to use for the deployment. If not specified, the default endpoint config will be used." }, "deployConfig": { "description": "Optional. The deploy config to use for the deployment. If not specified, the default deploy config will be used.", "$ref": "GoogleCloudAiplatformV1beta1DeployRequestDeployConfig" } } }, "GoogleCloudAiplatformV1beta1FeatureViewSyncConfig": { "id": "GoogleCloudAiplatformV1beta1FeatureViewSyncConfig", "type": "object", "description": "Configuration for Sync. Only one option is set.", "properties": { "continuous": { "type": "boolean", "description": "Optional. If true, syncs the FeatureView in a continuous manner to Online Store." }, "cron": { "type": "string", "description": "Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: \"CRON_TZ=${IANA_TIME_ZONE}\" or \"TZ=${IANA_TIME_ZONE}\". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, \"CRON_TZ=America/New_York 1 * * * *\", or \"TZ=America/New_York 1 * * * *\"." } } }, "GoogleCloudAiplatformV1beta1SecretEnvVar": { "description": "Represents an environment variable where the value is a secret in Cloud Secret Manager.", "type": "object", "id": "GoogleCloudAiplatformV1beta1SecretEnvVar", "properties": { "secretRef": { "description": "Required. Reference to a secret stored in the Cloud Secret Manager that will provide the value for this environment variable.", "$ref": "GoogleCloudAiplatformV1beta1SecretRef" }, "name": { "type": "string", "description": "Required. Name of the secret environment variable." } } }, "GenaiVertexV1beta1ImageResponseFormat": { "id": "GenaiVertexV1beta1ImageResponseFormat", "properties": { "imageSize": { "description": "The size of the image output.", "enumDescriptions": [ "Default value. This value is unused.", "512px image size.", "1K image size.", "2K image size.", "4K image size." ], "type": "string", "enum": [ "IMAGE_SIZE_UNSPECIFIED", "IMAGE_SIZE_FIVE_TWELVE", "IMAGE_SIZE_ONE_K", "IMAGE_SIZE_TWO_K", "IMAGE_SIZE_FOUR_K" ] }, "aspectRatio": { "enumDescriptions": [ "Default value. This value is unused.", "1:1 aspect ratio.", "2:3 aspect ratio.", "3:2 aspect ratio.", "3:4 aspect ratio.", "4:3 aspect ratio.", "4:5 aspect ratio.", "5:4 aspect ratio.", "9:16 aspect ratio.", "16:9 aspect ratio.", "21:9 aspect ratio.", "1:8 aspect ratio.", "8:1 aspect ratio.", "1:4 aspect ratio.", "4:1 aspect ratio." ], "type": "string", "description": "The aspect ratio for the image output.", "enum": [ "ASPECT_RATIO_UNSPECIFIED", "ASPECT_RATIO_ONE_BY_ONE", "ASPECT_RATIO_TWO_BY_THREE", "ASPECT_RATIO_THREE_BY_TWO", "ASPECT_RATIO_THREE_BY_FOUR", "ASPECT_RATIO_FOUR_BY_THREE", "ASPECT_RATIO_FOUR_BY_FIVE", "ASPECT_RATIO_FIVE_BY_FOUR", "ASPECT_RATIO_NINE_BY_SIXTEEN", "ASPECT_RATIO_SIXTEEN_BY_NINE", "ASPECT_RATIO_TWENTY_ONE_BY_NINE", "ASPECT_RATIO_ONE_BY_EIGHT", "ASPECT_RATIO_EIGHT_BY_ONE", "ASPECT_RATIO_ONE_BY_FOUR", "ASPECT_RATIO_FOUR_BY_ONE" ] }, "mimeType": { "enum": [ "TYPE_UNSPECIFIED", "TYPE_JPEG" ], "description": "The MIME type of the image output.", "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "JPEG image format." ] }, "delivery": { "type": "string", "description": "The delivery mode for the image output.", "enum": [ "DELIVERY_UNSPECIFIED", "INLINE", "URI" ], "enumDescriptions": [ "Default value. This value is unused.", "Image data is returned inline in the response.", "Image data is returned as a URI." ] } }, "type": "object", "description": "Configuration for image output format." }, "GoogleCloudAiplatformV1beta1A2ATaskRecordEventData": { "properties": { "statusUpdate": { "description": "Optional. An update to the task's state and status message.", "$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordStatusUpdate" }, "artifactChange": { "$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordArtifactChange", "description": "Optional. A change to one of the task's artifacts." }, "historyAppend": { "$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordHistoryAppend", "description": "Optional. A new message appended to the task history." }, "metadataChange": { "$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordMetadataChange", "description": "Optional. A change to the task-level metadata." } }, "id": "GoogleCloudAiplatformV1beta1A2ATaskRecordEventData", "type": "object", "description": "The data describing the change carried by an A2ATaskRecordEvent. Multiple changes can be set in a single event." }, "GoogleCloudAiplatformV1beta1ListNasJobsResponse": { "description": "Response message for JobService.ListNasJobs", "id": "GoogleCloudAiplatformV1beta1ListNasJobsResponse", "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results. Pass to ListNasJobsRequest.page_token to obtain that page." }, "nasJobs": { "description": "List of NasJobs in the requested page. NasJob.nas_job_output of the jobs will not be returned.", "items": { "$ref": "GoogleCloudAiplatformV1beta1NasJob" }, "type": "array" } } }, "GoogleCloudAiplatformV1beta1SummarizationQualitySpec": { "type": "object", "properties": { "version": { "format": "int32", "description": "Optional. Which version to use for evaluation.", "type": "integer" }, "useReference": { "type": "boolean", "description": "Optional. Whether to use instance.reference to compute summarization quality." } }, "id": "GoogleCloudAiplatformV1beta1SummarizationQualitySpec", "description": "Spec for summarization quality score metric." }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata": { "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata", "properties": { "costMilliNodeHours": { "type": "string", "description": "The actual training cost of creating this model, expressed in milli node hours, i.e. 1,000 value in this field means 1 node hour. Guaranteed to not exceed inputs.budgetMilliNodeHours.", "format": "int64" }, "successfulStopReason": { "description": "For successful job completions, this is the reason why the job has finished.", "enum": [ "SUCCESSFUL_STOP_REASON_UNSPECIFIED", "BUDGET_REACHED", "MODEL_CONVERGED" ], "type": "string", "enumDescriptions": [ "Should not be set.", "The inputs.budgetMilliNodeHours had been reached.", "Further training of the Model ceased to increase its quality, since it already has converged." ] } }, "type": "object" }, "GoogleCloudAiplatformV1beta1QuestionAnsweringRelevanceResult": { "description": "Spec for question answering relevance result.", "id": "GoogleCloudAiplatformV1beta1QuestionAnsweringRelevanceResult", "properties": { "confidence": { "format": "float", "type": "number", "description": "Output only. Confidence for question answering relevance score.", "readOnly": true }, "explanation": { "type": "string", "description": "Output only. Explanation for question answering relevance score.", "readOnly": true }, "score": { "type": "number", "description": "Output only. Question Answering Relevance score.", "readOnly": true, "format": "float" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry": { "description": "Entry for the Quantiles loss type optimization objective.", "type": "object", "properties": { "observedQuantile": { "format": "double", "type": "number", "description": "This is a custom metric that calculates the percentage of true values that were less than the predicted value for that quantile. Only populated when optimization_objective is minimize-quantile-loss and each entry corresponds to an entry in quantiles The percent value can be used to compare with the quantile value, which is the target value." }, "quantile": { "type": "number", "description": "The quantile for this entry.", "format": "double" }, "scaledPinballLoss": { "format": "float", "description": "The scaled pinball loss of this quantile.", "type": "number" } }, "id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsForecastingEvaluationMetricsQuantileMetricsEntry" }, "GenaiVertexV1beta1ModelOutputStep": { "properties": { "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "GoogleRpcStatus", "deprecated": true }, "content": { "items": { "$ref": "GenaiVertexV1beta1Content" }, "type": "array" } }, "description": "Output generated by the model.", "type": "object", "id": "GenaiVertexV1beta1ModelOutputStep" }, "GenaiVertexV1beta1UrlContextCallContentUrlContextCallArguments": { "description": "The arguments to pass to the URL context.", "properties": { "urls": { "description": "The URLs to fetch.", "type": "array", "items": { "type": "string" } } }, "id": "GenaiVertexV1beta1UrlContextCallContentUrlContextCallArguments", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation": { "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation", "description": "Training pipeline will infer the proper transformation based on the statistic of dataset.", "properties": { "columnName": { "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1MetadataStore": { "description": "Instance of a metadata store. Contains a set of metadata that can be queried.", "properties": { "name": { "readOnly": true, "description": "Output only. The resource name of the MetadataStore instance.", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Output only. Timestamp when this MetadataStore was created.", "readOnly": true, "type": "string" }, "updateTime": { "type": "string", "description": "Output only. Timestamp when this MetadataStore was last updated.", "format": "google-datetime", "readOnly": true }, "description": { "description": "Description of the MetadataStore.", "type": "string" }, "state": { "$ref": "GoogleCloudAiplatformV1beta1MetadataStoreMetadataStoreState", "readOnly": true, "description": "Output only. State information of the MetadataStore." }, "encryptionSpec": { "description": "Customer-managed encryption key spec for a Metadata Store. If set, this Metadata Store and all sub-resources of this Metadata Store are secured using this key.", "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec" }, "dataplexConfig": { "$ref": "GoogleCloudAiplatformV1beta1MetadataStoreDataplexConfig", "description": "Optional. Dataplex integration settings." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1MetadataStore" }, "GoogleCloudAiplatformV1beta1PurgeContextsResponse": { "description": "Response message for MetadataService.PurgeContexts.", "type": "object", "id": "GoogleCloudAiplatformV1beta1PurgeContextsResponse", "properties": { "purgeCount": { "type": "string", "format": "int64", "description": "The number of Contexts that this request deleted (or, if `force` is false, the number of Contexts that will be deleted). This can be an estimate." }, "purgeSample": { "type": "array", "items": { "type": "string" }, "description": "A sample of the Context names that will be deleted. Only populated if `force` is set to false. The maximum number of samples is 100 (it is possible to return fewer)." } } }, "GenaiVertexV1beta1WordInfo": { "id": "GenaiVertexV1beta1WordInfo", "description": "Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution.", "properties": { "speaker": { "type": "string", "description": "Optional. Speaker label for this word (e.g. \"spk_1\", \"spk_2\"). Present when diarization_mode is set in TranscriptionConfig." }, "startOffset": { "type": "string", "description": "Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains \"word\".", "format": "google-duration" }, "text": { "description": "The transcribed word.", "type": "string" }, "endOffset": { "type": "string", "description": "End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains \"word\".", "format": "google-duration" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1RagFileParsingConfig": { "id": "GoogleCloudAiplatformV1beta1RagFileParsingConfig", "type": "object", "properties": { "useAdvancedPdfParsing": { "description": "Whether to use advanced PDF parsing.", "type": "boolean", "deprecated": true }, "layoutParser": { "$ref": "GoogleCloudAiplatformV1beta1RagFileParsingConfigLayoutParser", "description": "The Layout Parser to use for RagFiles." }, "llmParser": { "description": "The LLM Parser to use for RagFiles.", "$ref": "GoogleCloudAiplatformV1beta1RagFileParsingConfigLlmParser" }, "advancedParser": { "$ref": "GoogleCloudAiplatformV1beta1RagFileParsingConfigAdvancedParser", "description": "The Advanced Parser to use for RagFiles." } }, "description": "Specifies the parsing config for RagFiles." }, "GoogleCloudAiplatformV1beta1SlackSource": { "description": "The Slack source for the ImportRagFilesRequest.", "properties": { "channels": { "description": "Required. The Slack channels.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1SlackSourceSlackChannels" } } }, "id": "GoogleCloudAiplatformV1beta1SlackSource", "type": "object" }, "GoogleCloudAiplatformV1beta1DeleteOperationMetadata": { "description": "Details of operations that perform deletes of any entities.", "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "The common part of the operation metadata." } }, "id": "GoogleCloudAiplatformV1beta1DeleteOperationMetadata", "type": "object" }, "GoogleCloudAiplatformV1beta1MemoryProfile": { "id": "GoogleCloudAiplatformV1beta1MemoryProfile", "properties": { "schemaId": { "type": "string", "description": "Represents the ID of the schema. This ID corresponds to the `schema_id` defined inside the SchemaConfig, under StructuredMemoryCustomizationConfig." }, "profile": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Represents the profile data.", "type": "object" } }, "type": "object", "description": "A memory profile." }, "GoogleCloudAiplatformV1beta1Citation": { "type": "object", "description": "A citation for a piece of generatedcontent.", "id": "GoogleCloudAiplatformV1beta1Citation", "properties": { "uri": { "readOnly": true, "type": "string", "description": "Output only. The URI of the source of the citation." }, "title": { "description": "Output only. The title of the source of the citation.", "readOnly": true, "type": "string" }, "endIndex": { "description": "Output only. The end index of the citation in the content.", "readOnly": true, "format": "int32", "type": "integer" }, "license": { "description": "Output only. The license of the source of the citation.", "readOnly": true, "type": "string" }, "publicationDate": { "readOnly": true, "$ref": "GoogleTypeDate", "description": "Output only. The publication date of the source of the citation." }, "startIndex": { "type": "integer", "readOnly": true, "format": "int32", "description": "Output only. The start index of the citation in the content." } } }, "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfig": { "description": "The Evalution configuration used for the evaluation run.", "properties": { "metrics": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunMetric" }, "description": "Optional. The metrics to be calculated in the evaluation run. Required when analysis_configs is not set." }, "outputConfig": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigOutputConfig", "description": "Optional. The output config for the evaluation run." }, "autoraterConfig": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigAutoraterConfig", "description": "Optional. The autorater config for the evaluation run." }, "lossAnalysisConfig": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1LossAnalysisConfig" }, "description": "Optional. Specifications for loss analysis. Each config can be specified for one metric." }, "cloudLoggingConfig": { "description": "Optional. Configuration for exporting evaluation results to Cloud Logging.", "$ref": "GoogleCloudAiplatformV1beta1CloudLoggingConfig" }, "promptTemplate": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigPromptTemplate", "description": "The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values." }, "rubricConfigs": { "items": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationRubricConfig" }, "type": "array", "description": "Optional. The rubric configs for the evaluation run. They are used to generate rubrics which can be used by rubric-based metrics. Multiple rubric configs can be specified for rubric generation but only one rubric config can be used for a rubric-based metric. If more than one rubric config is provided, the evaluation metric must specify a rubric group key. Note that if a generation spec is specified on both a rubric config and an evaluation metric, the rubrics generated for the metric will be used for evaluation." }, "datasetCustomMetrics": { "description": "Optional. Specifications for custom dataset-level aggregations.", "items": { "$ref": "GoogleCloudAiplatformV1beta1DatasetCustomMetric" }, "type": "array" } }, "id": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfig", "type": "object" }, "GoogleCloudAiplatformV1beta1ListTensorboardExperimentsResponse": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ListTensorboardExperimentsResponse", "properties": { "tensorboardExperiments": { "items": { "$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment" }, "description": "The TensorboardExperiments mathching the request.", "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as ListTensorboardExperimentsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "description": "Response message for TensorboardService.ListTensorboardExperiments." }, "GoogleCloudAiplatformV1beta1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec": { "properties": { "frequency": { "format": "int32", "description": "Required. Frequency of search trials to start train stage. Top N [TrainTrialSpec.max_parallel_trial_count] search trials will be trained for every M [TrainTrialSpec.frequency] trials searched.", "type": "integer" }, "trainTrialJobSpec": { "description": "Required. The spec of a train trial job. The same spec applies to all train trials.", "$ref": "GoogleCloudAiplatformV1beta1CustomJobSpec" }, "maxParallelTrialCount": { "type": "integer", "format": "int32", "description": "Required. The maximum number of trials to run in parallel." } }, "description": "Represent spec for train trials.", "type": "object", "id": "GoogleCloudAiplatformV1beta1NasJobSpecMultiTrialAlgorithmSpecTrainTrialSpec" }, "GoogleCloudAiplatformV1beta1ToolGoogleSearch": { "id": "GoogleCloudAiplatformV1beta1ToolGoogleSearch", "properties": { "searchTypes": { "description": "Optional. The set of search types to enable. If not set, web search is enabled by default.", "$ref": "GoogleCloudAiplatformV1beta1ToolGoogleSearchSearchTypes" }, "blockingConfidence": { "enum": [ "PHISH_BLOCK_THRESHOLD_UNSPECIFIED", "BLOCK_LOW_AND_ABOVE", "BLOCK_MEDIUM_AND_ABOVE", "BLOCK_HIGH_AND_ABOVE", "BLOCK_HIGHER_AND_ABOVE", "BLOCK_VERY_HIGH_AND_ABOVE", "BLOCK_ONLY_EXTREMELY_HIGH" ], "type": "string", "description": "Optional. Sites with confidence level chosen & above this value will be blocked from the search results.", "enumDescriptions": [ "Defaults to unspecified.", "Blocks Low and above confidence URL that is risky.", "Blocks Medium and above confidence URL that is risky.", "Blocks High and above confidence URL that is risky.", "Blocks Higher and above confidence URL that is risky.", "Blocks Very high and above confidence URL that is risky.", "Blocks Extremely high confidence URL that is risky." ] }, "excludeDomains": { "type": "array", "description": "Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: [\"amazon.com\", \"facebook.com\"].", "items": { "type": "string" } } }, "description": "GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.", "type": "object" }, "GoogleCloudAiplatformV1beta1MigrateResourceRequestMigrateAutomlModelConfig": { "description": "Config for migrating Model in automl.googleapis.com to Vertex AI's Model.", "properties": { "modelDisplayName": { "type": "string", "description": "Optional. Display name of the model in Vertex AI. System will pick a display name if unspecified." }, "model": { "description": "Required. Full resource name of automl Model. Format: `projects/{project}/locations/{location}/models/{model}`.", "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1MigrateResourceRequestMigrateAutomlModelConfig" }, "GoogleCloudAiplatformV1beta1UploadModelOperationMetadata": { "properties": { "genericMetadata": { "description": "The common part of the operation metadata.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "type": "object", "description": "Details of ModelService.UploadModel operation.", "id": "GoogleCloudAiplatformV1beta1UploadModelOperationMetadata" }, "GoogleCloudAiplatformV1beta1TrajectoryPrecisionInput": { "description": "Instances and metric spec for TrajectoryPrecision metric.", "properties": { "instances": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1TrajectoryPrecisionInstance" }, "description": "Required. Repeated TrajectoryPrecision instance." }, "metricSpec": { "description": "Required. Spec for TrajectoryPrecision metric.", "$ref": "GoogleCloudAiplatformV1beta1TrajectoryPrecisionSpec" } }, "id": "GoogleCloudAiplatformV1beta1TrajectoryPrecisionInput", "type": "object" }, "GoogleCloudAiplatformV1beta1FindNeighborsResponseNeighbor": { "description": "A neighbor of the query vector.", "properties": { "distance": { "description": "The distance between the neighbor and the dense embedding query.", "type": "number", "format": "double" }, "sparseDistance": { "type": "number", "description": "The distance between the neighbor and the query sparse_embedding.", "format": "double" }, "datapoint": { "description": "The datapoint of the neighbor. Note that full datapoints are returned only when \"return_full_datapoint\" is set to true. Otherwise, only the \"datapoint_id\" and \"crowding_tag\" fields are populated.", "$ref": "GoogleCloudAiplatformV1beta1IndexDatapoint" } }, "id": "GoogleCloudAiplatformV1beta1FindNeighborsResponseNeighbor", "type": "object" }, "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilitySessionScopeInactivityTrigger": { "properties": { "threshold": { "type": "string", "description": "Required. The amount of time that must pass with no new traces before a session is considered ready for evaluation. This is a required field if InactivityTrigger is used. The value must be a positive duration no greater than 7 days (604800 seconds).", "format": "google-duration" } }, "type": "object", "description": "Configuration for inactivity based session completion.", "id": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilitySessionScopeInactivityTrigger" }, "CloudAiLargeModelsVisionImageRAIScores": { "type": "object", "id": "CloudAiLargeModelsVisionImageRAIScores", "properties": { "agileWatermarkDetectionScore": { "description": "Agile watermark score for image.", "type": "number", "format": "double" } }, "description": "RAI scores for generated image returned." }, "GoogleCloudAiplatformV1beta1SummarizationQualityResult": { "properties": { "confidence": { "description": "Output only. Confidence for summarization quality score.", "format": "float", "type": "number", "readOnly": true }, "score": { "format": "float", "description": "Output only. Summarization Quality score.", "readOnly": true, "type": "number" }, "explanation": { "description": "Output only. Explanation for summarization quality score.", "readOnly": true, "type": "string" } }, "type": "object", "description": "Spec for summarization quality result.", "id": "GoogleCloudAiplatformV1beta1SummarizationQualityResult" }, "GoogleCloudAiplatformV1beta1ExactMatchInstance": { "type": "object", "properties": { "prediction": { "description": "Required. Output of the evaluated model.", "type": "string" }, "reference": { "description": "Required. Ground truth used to compare against the prediction.", "type": "string" } }, "description": "Spec for exact match instance.", "id": "GoogleCloudAiplatformV1beta1ExactMatchInstance" }, "GoogleCloudAiplatformV1beta1PreferenceOptimizationHyperParameters": { "description": "Hyperparameters for Preference Optimization.", "properties": { "learningRateMultiplier": { "type": "number", "format": "double", "description": "Optional. Multiplier for adjusting the default learning rate." }, "adapterSize": { "description": "Optional. Adapter size for preference optimization.", "enumDescriptions": [ "Adapter size is unspecified.", "Adapter size 1.", "Adapter size 2.", "Adapter size 4.", "Adapter size 8.", "Adapter size 16.", "Adapter size 32." ], "enum": [ "ADAPTER_SIZE_UNSPECIFIED", "ADAPTER_SIZE_ONE", "ADAPTER_SIZE_TWO", "ADAPTER_SIZE_FOUR", "ADAPTER_SIZE_EIGHT", "ADAPTER_SIZE_SIXTEEN", "ADAPTER_SIZE_THIRTY_TWO" ], "type": "string" }, "beta": { "description": "Optional. Weight for KL Divergence regularization.", "format": "double", "type": "number" }, "epochCount": { "format": "int64", "type": "string", "description": "Optional. Number of complete passes the model makes over the entire training dataset during training." } }, "id": "GoogleCloudAiplatformV1beta1PreferenceOptimizationHyperParameters", "type": "object" }, "GoogleCloudAiplatformV1beta1RubricContent": { "description": "Content of the rubric, defining the testable criteria.", "id": "GoogleCloudAiplatformV1beta1RubricContent", "properties": { "property": { "description": "Evaluation criteria based on a specific property.", "$ref": "GoogleCloudAiplatformV1beta1RubricContentProperty" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ExplanationMetadataOutputMetadata": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ExplanationMetadataOutputMetadata", "properties": { "outputTensorName": { "type": "string", "description": "Name of the output tensor. Required and is only applicable to Vertex AI provided images for Tensorflow." }, "displayNameMappingKey": { "type": "string", "description": "Specify a field name in the prediction to look for the display name. Use this if the prediction contains the display names for the outputs. The display names in the prediction must have the same shape of the outputs, so that it can be located by Attribution.output_index for a specific output." }, "indexDisplayNameMapping": { "type": "any", "description": "Static mapping between the index and display name. Use this if the outputs are a deterministic n-dimensional array, e.g. a list of scores of all the classes in a pre-defined order for a multi-classification Model. It's not feasible if the outputs are non-deterministic, e.g. the Model produces top-k classes or sort the outputs by their values. The shape of the value must be an n-dimensional array of strings. The number of dimensions must match that of the outputs to be explained. The Attribution.output_display_name is populated by locating in the mapping with Attribution.output_index." } }, "description": "Metadata of the prediction output to be explained." }, "GoogleCloudAiplatformV1beta1GoogleMapsPlaces": { "id": "GoogleCloudAiplatformV1beta1GoogleMapsPlaces", "type": "object", "properties": {}, "description": "Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified." }, "GoogleCloudAiplatformV1beta1DirectUploadSource": { "id": "GoogleCloudAiplatformV1beta1DirectUploadSource", "type": "object", "description": "The input content is encapsulated and uploaded in the request.", "properties": {} }, "GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDbKNN": { "type": "object", "properties": {}, "id": "GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDbKNN", "description": "Config for KNN search." }, "GoogleCloudAiplatformV1beta1RagManagedDbConfigScaled": { "description": "Scaled tier offers production grade performance along with autoscaling functionality. It is suitable for customers with large amounts of data or performance sensitive workloads.", "id": "GoogleCloudAiplatformV1beta1RagManagedDbConfigScaled", "type": "object", "properties": {} }, "GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResultPlaces": { "id": "GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResultPlaces", "type": "object", "properties": { "url": { "type": "string", "description": "URI reference of the place." }, "placeId": { "description": "The ID of the place, in `places/{place_id}` format.", "type": "string" }, "name": { "description": "Title of the place.", "type": "string" }, "reviewSnippets": { "items": { "$ref": "GenaiVertexV1beta1ReviewSnippet" }, "description": "Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.", "type": "array" } } }, "GoogleCloudAiplatformV1beta1RagMetadataSchemaDetailsListConfig": { "description": "Config for List data type.", "type": "object", "properties": { "valueSchema": { "$ref": "GoogleCloudAiplatformV1beta1RagMetadataSchemaDetails", "description": "The value's data type in the list." } }, "id": "GoogleCloudAiplatformV1beta1RagMetadataSchemaDetailsListConfig" }, "GoogleCloudAiplatformV1beta1RayClusterAutoscalingSpec": { "id": "GoogleCloudAiplatformV1beta1RayClusterAutoscalingSpec", "description": "Ray cluster level autoscaling configuration.", "type": "object", "properties": { "idleTimeoutMinutes": { "description": "Optional. The number of minutes that need to pass before an idle worker node is removed by the autoscaler. Default is 5 mins.", "format": "int64", "type": "string" }, "upscalingSpeed": { "format": "int64", "type": "string", "description": "Optional. The number of nodes allowed to be pending as a multiple of the current number of nodes. [OSS Ray reference](https://docs.ray.io/en/latest/cluster/vms/user-guides/configuring-autoscaling.html#upscaling-and-downscaling-speed)" } } }, "GoogleCloudAiplatformV1beta1ModelEvaluationSlice": { "description": "A collection of metrics calculated by comparing Model's predictions on a slice of the test data against ground truth annotations.", "properties": { "name": { "description": "Output only. The resource name of the ModelEvaluationSlice.", "readOnly": true, "type": "string" }, "metricsSchemaUri": { "description": "Output only. Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluationSlice. 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).", "type": "string", "readOnly": true }, "slice": { "description": "Output only. The slice of the test data that is used to evaluate the Model.", "$ref": "GoogleCloudAiplatformV1beta1ModelEvaluationSliceSlice", "readOnly": true }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. Timestamp when this ModelEvaluationSlice was created.", "format": "google-datetime" }, "modelExplanation": { "readOnly": true, "description": "Output only. Aggregated explanation metrics for the Model's prediction output over the data this ModelEvaluation uses. This field is populated only if the Model is evaluated with explanations, and only for tabular Models.", "$ref": "GoogleCloudAiplatformV1beta1ModelExplanation" }, "metrics": { "type": "any", "readOnly": true, "description": "Output only. Sliced evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ModelEvaluationSlice" }, "CloudAiLargeModelsVisionImageImageSize": { "type": "object", "id": "CloudAiLargeModelsVisionImageImageSize", "properties": { "width": { "type": "integer", "format": "int32" }, "height": { "type": "integer", "format": "int32" }, "channels": { "type": "integer", "format": "int32" } }, "description": "Image size." }, "GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec": { "description": "Specificies a metric that is populated by evaluating user-defined Python code.", "type": "object", "id": "GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec", "properties": { "codeExecutionRegion": { "type": "string", "description": "Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED." }, "evaluationFunction": { "type": "string", "description": "Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -\u003e float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text=\"The answer is 4.\"), reference=EvaluationInstance.InstanceData(text=\"4\") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -\u003e float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function." } } }, "GoogleCloudAiplatformV1beta1UpdateTensorboardOperationMetadata": { "type": "object", "id": "GoogleCloudAiplatformV1beta1UpdateTensorboardOperationMetadata", "properties": { "genericMetadata": { "description": "Operation metadata for Tensorboard.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "description": "Details of operations that perform update Tensorboard." }, "GoogleCloudAiplatformV1beta1ExplanationSpec": { "type": "object", "description": "Specification of Model explanation.", "properties": { "parameters": { "description": "Required. Parameters that configure explaining of the Model's predictions.", "$ref": "GoogleCloudAiplatformV1beta1ExplanationParameters" }, "metadata": { "$ref": "GoogleCloudAiplatformV1beta1ExplanationMetadata", "description": "Optional. Metadata describing the Model's input and output for explanation." } }, "id": "GoogleCloudAiplatformV1beta1ExplanationSpec" }, "GoogleCloudAiplatformV1beta1BatchImportModelEvaluationSlicesRequest": { "id": "GoogleCloudAiplatformV1beta1BatchImportModelEvaluationSlicesRequest", "description": "Request message for ModelService.BatchImportModelEvaluationSlices", "properties": { "modelEvaluationSlices": { "items": { "$ref": "GoogleCloudAiplatformV1beta1ModelEvaluationSlice" }, "description": "Required. Model evaluation slice resource to be imported.", "type": "array" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1StudySpecMetricSpec": { "properties": { "metricId": { "type": "string", "description": "Required. The ID of the metric. Must not contain whitespaces and must be unique amongst all MetricSpecs." }, "safetyConfig": { "$ref": "GoogleCloudAiplatformV1beta1StudySpecMetricSpecSafetyMetricConfig", "description": "Used for safe search. In the case, the metric will be a safety metric. You must provide a separate metric for objective metric." }, "goal": { "enumDescriptions": [ "Goal Type will default to maximize.", "Maximize the goal metric.", "Minimize the goal metric." ], "description": "Required. The optimization goal of the metric.", "enum": [ "GOAL_TYPE_UNSPECIFIED", "MAXIMIZE", "MINIMIZE" ], "type": "string" } }, "description": "Represents a metric to optimize.", "id": "GoogleCloudAiplatformV1beta1StudySpecMetricSpec", "type": "object" }, "GoogleCloudAiplatformV1beta1ListModelMonitoringJobsResponse": { "description": "Response message for ModelMonitoringService.ListModelMonitoringJobs.", "id": "GoogleCloudAiplatformV1beta1ListModelMonitoringJobsResponse", "properties": { "modelMonitoringJobs": { "type": "array", "description": "A list of ModelMonitoringJobs that matches the specified filter in the request.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringJob" } }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1PartMediaResolution": { "type": "object", "id": "GoogleCloudAiplatformV1beta1PartMediaResolution", "properties": { "level": { "description": "The tokenization quality used for given media.", "type": "string", "enum": [ "MEDIA_RESOLUTION_UNSPECIFIED", "MEDIA_RESOLUTION_LOW", "MEDIA_RESOLUTION_MEDIUM", "MEDIA_RESOLUTION_HIGH", "MEDIA_RESOLUTION_ULTRA_HIGH" ], "enumDescriptions": [ "Media resolution has not been set.", "Media resolution set to low.", "Media resolution set to medium.", "Media resolution set to high.", "Media resolution set to ultra high. This is for image only." ] } }, "description": "per part media resolution. Media resolution for the input media." }, "GoogleCloudAiplatformV1beta1GenieSource": { "description": "Contains information about the source of the models generated from Generative AI Studio.", "properties": { "baseModelUri": { "type": "string", "description": "Required. The public base model URI." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1GenieSource" }, "CloudAiLargeModelsVisionGenerateVideoResponse": { "type": "object", "description": "Generate video response.", "properties": { "raiMediaFilteredCount": { "type": "integer", "description": "Returns if any videos were filtered due to RAI policies.", "format": "int32" }, "generatedSamples": { "description": "The generates samples.", "items": { "$ref": "CloudAiLargeModelsVisionMedia" }, "type": "array" }, "videos": { "items": { "$ref": "CloudAiLargeModelsVisionGenerateVideoResponseVideo" }, "type": "array", "description": "List of videos, used to align naming with the external response." }, "raiMediaFilteredReasons": { "description": "Returns rai failure reasons if any.", "items": { "type": "string" }, "type": "array" } }, "id": "CloudAiLargeModelsVisionGenerateVideoResponse" }, "GoogleCloudAiplatformV1beta1FindNeighborsResponse": { "id": "GoogleCloudAiplatformV1beta1FindNeighborsResponse", "type": "object", "description": "The response message for MatchService.FindNeighbors.", "properties": { "nearestNeighbors": { "items": { "$ref": "GoogleCloudAiplatformV1beta1FindNeighborsResponseNearestNeighbors" }, "description": "The nearest neighbors of the query datapoints.", "type": "array" } } }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation", "description": "Treats the column as text array and performs following transformation functions. * Concatenate all text values in the array into a single text value using a space (\" \") as a delimiter, and then treat the result as a single text value. Apply the transformations for Text columns. * Empty arrays treated as an empty text.", "properties": { "columnName": { "type": "string" } } }, "GoogleCloudAiplatformV1beta1RolloutOptions": { "properties": { "maxUnavailableReplicas": { "type": "integer", "description": "Absolute count of replicas allowed to be unavailable.", "format": "int32" }, "maxSurgeReplicas": { "description": "Absolute count of allowed additional replicas.", "type": "integer", "format": "int32" }, "maxSurgePercentage": { "format": "int32", "type": "integer", "description": "Percentage of allowed additional replicas. For autoscaling deployments, this refers to the target replica count." }, "previousDeployedModel": { "description": "ID of the DeployedModel that this deployment should replace.", "type": "string" }, "revisionNumber": { "type": "integer", "description": "Output only. Read-only. Revision number determines the relative priority of DeployedModels in the same rollout. The DeployedModel with the largest revision number specifies the intended state of the deployment.", "format": "int32", "readOnly": true }, "maxUnavailablePercentage": { "format": "int32", "description": "Percentage of replicas allowed to be unavailable. For autoscaling deployments, this refers to the target replica count.", "type": "integer" } }, "id": "GoogleCloudAiplatformV1beta1RolloutOptions", "type": "object", "description": "Configuration for rolling deployments." }, "GoogleIamV1TestIamPermissionsRequest": { "id": "GoogleIamV1TestIamPermissionsRequest", "type": "object", "properties": { "permissions": { "items": { "type": "string" }, "type": "array", "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions)." } }, "description": "Request message for `TestIamPermissions` method." }, "GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine": { "id": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine", "properties": { "name": { "description": "Identifier. The resource name of the SemanticGovernancePolicyEngine. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine", "type": "string" }, "pscForwardingRule": { "type": "string", "readOnly": true, "description": "Output only. The URI of the PSC endpoint resource created in customer project. Format: projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}" }, "gatewayConfigs": { "description": "Optional. Configurations for gateways. The keys are user-defined names for each gateway. At most 5 gateway configurations are allowed.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1GatewayConfig" } }, "state": { "description": "Output only. The state of the SemanticGovernancePolicyEngine.", "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "ACTIVE", "DEPROVISIONING", "INACTIVE", "FAILED" ], "readOnly": true, "enumDescriptions": [ "Default value. This value is unused.", "A provisioning operation is in progress. The engine will transition to ACTIVE on success or FAILED on failure.", "The engine and all of its gateway configurations are provisioned and ready to serve traffic.", "A deprovisioning operation is in progress. The engine will transition to INACTIVE on success or FAILED on failure.", "The engine has no provisioned infrastructure: either never provisioned, or successfully deprovisioned.", "The most recent provisioning or deprovisioning operation failed. The engine may have partial infrastructure that needs explicit deprovision; the engine may be either re-provisioned or deprovisioned to recover." ], "type": "string" }, "updateTime": { "type": "string", "description": "Output only. Timestamp when this SemanticGovernancePolicyEngine was last updated.", "readOnly": true, "format": "google-datetime" }, "ipAddress": { "type": "string", "readOnly": true, "description": "Output only. The private IPv4 address of the PSC endpoint." }, "createTime": { "description": "Output only. Timestamp when this SemanticGovernancePolicyEngine was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "pscServiceAttachment": { "type": "string", "readOnly": true, "description": "Output only. URI of the PSC attachment resource provided by SGP. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment}" } }, "type": "object", "description": "Define a singleton SemanticGovernancePolicyEngine resource under a project and location." }, "GoogleCloudAiplatformV1beta1GenerateSyntheticDataRequest": { "properties": { "taskDescription": { "description": "Generates synthetic data based on a high-level description of the task or data you want.", "$ref": "GoogleCloudAiplatformV1beta1TaskDescriptionStrategy" }, "examples": { "items": { "$ref": "GoogleCloudAiplatformV1beta1SyntheticExample" }, "description": "Optional. A list of few-shot examples that help the model understand the desired style, tone, and format of the generated synthetic data. Providing these few-shot examples can significantly improve the quality and relevance of the output.", "type": "array" }, "count": { "type": "integer", "description": "Required. The number of synthetic examples to generate. For this stateless API, you can generate up to 50 examples in a single request.", "format": "int32" }, "outputFieldSpecs": { "items": { "$ref": "GoogleCloudAiplatformV1beta1OutputFieldSpec" }, "type": "array", "description": "Required. Defines the schema of each synthetic example to be generated, defined by a list of fields." } }, "description": "Request message for DataFoundryService.GenerateSyntheticData. It contains the settings and information needed to generate synthetic data.", "type": "object", "id": "GoogleCloudAiplatformV1beta1GenerateSyntheticDataRequest" }, "GoogleCloudAiplatformV1beta1CancelEvaluationRunRequest": { "id": "GoogleCloudAiplatformV1beta1CancelEvaluationRunRequest", "type": "object", "description": "Request message for EvaluationManagementService.CancelEvaluationRun.", "properties": {} }, "GoogleCloudAiplatformV1beta1SchemaPredictInstanceVideoObjectTrackingPredictionInstance": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaPredictInstanceVideoObjectTrackingPredictionInstance", "description": "Prediction input format for Video Object Tracking.", "properties": { "timeSegmentEnd": { "type": "string", "description": "The end, exclusive, of the video's time segment on which to perform the prediction. Expressed as a number of seconds as measured from the start of the video, with \"s\" appended at the end. Fractions are allowed, up to a microsecond precision, and \"inf\" or \"Infinity\" is allowed, which means the end of the video." }, "content": { "type": "string", "description": "The Google Cloud Storage location of the video on which to perform the prediction." }, "mimeType": { "type": "string", "description": "The MIME type of the content of the video. Only the following are supported: video/mp4 video/avi video/quicktime" }, "timeSegmentStart": { "type": "string", "description": "The beginning, inclusive, of the video's time segment on which to perform the prediction. Expressed as a number of seconds as measured from the start of the video, with \"s\" appended at the end. Fractions are allowed, up to a microsecond precision." } } }, "GoogleCloudAiplatformV1beta1FeatureViewFeatureRegistrySource": { "description": "A Feature Registry source for features that need to be synced to Online Store.", "type": "object", "properties": { "projectNumber": { "description": "Optional. The project number of the parent project of the Feature Groups.", "format": "int64", "type": "string" }, "featureGroups": { "type": "array", "description": "Required. List of features that need to be synced to Online Store.", "items": { "$ref": "GoogleCloudAiplatformV1beta1FeatureViewFeatureRegistrySourceFeatureGroup" } } }, "id": "GoogleCloudAiplatformV1beta1FeatureViewFeatureRegistrySource" }, "GoogleCloudAiplatformV1beta1ExportTensorboardTimeSeriesDataRequest": { "type": "object", "description": "Request message for TensorboardService.ExportTensorboardTimeSeriesData.", "properties": { "filter": { "type": "string", "description": "Exports the TensorboardTimeSeries' data that match the filter expression." }, "pageSize": { "type": "integer", "format": "int32", "description": "The maximum number of data points to return per page. The default page_size is 1000. Values must be between 1 and 10000. Values above 10000 are coerced to 10000." }, "pageToken": { "type": "string", "description": "A page token, received from a previous ExportTensorboardTimeSeriesData call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ExportTensorboardTimeSeriesData must match the call that provided the page token." }, "orderBy": { "type": "string", "description": "Field to use to sort the TensorboardTimeSeries' data. By default, TensorboardTimeSeries' data is returned in a pseudo random order." } }, "id": "GoogleCloudAiplatformV1beta1ExportTensorboardTimeSeriesDataRequest" }, "GenaiVertexV1beta1VertexAISearchConfig": { "type": "object", "id": "GenaiVertexV1beta1VertexAISearchConfig", "properties": { "engine": { "description": "Optional. Used to specify Vertex AI Search engine.", "type": "string" }, "datastores": { "items": { "type": "string" }, "description": "Optional. Used to specify Vertex AI Search datastores.", "type": "array" } }, "description": "Used to specify configuration for VertexAISearch." }, "GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDb": { "id": "GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDb", "type": "object", "properties": { "knn": { "$ref": "GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDbKNN", "description": "Performs a KNN search on RagCorpus. Default choice if not specified." }, "ann": { "description": "Performs an ANN search on RagCorpus. Use this if you have a lot of files (\u003e 10K) in your RagCorpus and want to reduce the search latency.", "$ref": "GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDbANN" } }, "description": "The config for the default RAG-managed Vector DB." }, "GoogleCloudAiplatformV1beta1TunedModel": { "type": "object", "id": "GoogleCloudAiplatformV1beta1TunedModel", "description": "The Model Registry Model and Online Prediction Endpoint associated with this TuningJob.", "properties": { "model": { "type": "string", "description": "Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`", "readOnly": true }, "endpoint": { "readOnly": true, "type": "string", "description": "Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`." }, "checkpoints": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1TunedModelCheckpoint" }, "readOnly": true, "description": "Output only. The checkpoints associated with this TunedModel. This field is only populated for tuning jobs that enable intermediate checkpoints." } } }, "GoogleCloudAiplatformV1beta1CreateRagMetadataRequest": { "type": "object", "properties": { "ragMetadata": { "$ref": "GoogleCloudAiplatformV1beta1RagMetadata", "description": "Required. The metadata to create." }, "parent": { "description": "Required. The parent resource where this metadata will be created. Format: `projects/{project_number}/locations/{location_id}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`", "type": "string" }, "ragMetadataId": { "description": "Optional. The ID to use for the metadata, which will become the final component of the metadata's resource name if the user chooses to specify. Otherwise, metadata id will be generated by system. This value should be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.", "type": "string" } }, "description": "Request message for CreateRagMetadata.", "id": "GoogleCloudAiplatformV1beta1CreateRagMetadataRequest" }, "GoogleCloudAiplatformV1beta1CreateSpecialistPoolOperationMetadata": { "id": "GoogleCloudAiplatformV1beta1CreateSpecialistPoolOperationMetadata", "properties": { "genericMetadata": { "description": "The operation generic information.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "description": "Runtime operation information for SpecialistPoolService.CreateSpecialistPool.", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputs": { "properties": { "unavailableAtForecastColumns": { "items": { "type": "string" }, "type": "array", "description": "Names of columns that are unavailable when a forecast is requested. This column contains information for the given entity (identified by the time_series_identifier_column) that is unknown before the forecast For example, actual weather on a given day." }, "forecastHorizon": { "type": "string", "description": "The amount of time into the future for which forecasted values for the target are returned. Expressed in number of units defined by the `data_granularity` field.", "format": "int64" }, "transformations": { "description": "Each transformation will apply transform function to given input column. And the result will be used for training. When creating transformation for BigQuery Struct column, the column should be flattened using \".\" as the delimiter.", "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation" }, "type": "array" }, "hierarchyConfig": { "description": "Configuration that defines the hierarchical relationship of time series and parameters for hierarchical forecasting strategies.", "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionHierarchyConfig" }, "targetColumn": { "description": "The name of the column that the Model is to predict values for. This column must be unavailable at forecast.", "type": "string" }, "availableAtForecastColumns": { "description": "Names of columns that are available and provided when a forecast is requested. These columns contain information for the given entity (identified by the time_series_identifier_column column) that is known at forecast. For example, predicted weather for a specific day.", "type": "array", "items": { "type": "string" } }, "holidayRegions": { "type": "array", "items": { "type": "string" }, "description": "The geographical region based on which the holiday effect is applied in modeling by adding holiday categorical array feature that include all holidays matching the date. This option only allowed when data_granularity is day. By default, holiday effect modeling is disabled. To turn it on, specify the holiday region using this option." }, "exportEvaluatedDataItemsConfig": { "description": "Configuration for exporting test set predictions to a BigQuery table. If this configuration is absent, then the export is not performed.", "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig" }, "timeSeriesAttributeColumns": { "description": "Column names that should be used as attribute columns. The value of these columns does not vary as a function of time. For example, store ID or item color.", "type": "array", "items": { "type": "string" } }, "trainBudgetMilliNodeHours": { "description": "Required. The train budget of creating this model, expressed in milli node hours i.e. 1,000 value in this field means 1 node hour. The training cost of the model will not exceed this budget. The final cost will be attempted to be close to the budget, though may end up being (even) noticeably smaller - at the backend's discretion. This especially may happen when further model training ceases to provide any improvements. If the budget is set to a value known to be insufficient to train a model for the given dataset, the training won't be attempted and will error. The train budget must be between 1,000 and 72,000 milli node hours, inclusive.", "format": "int64", "type": "string" }, "quantiles": { "items": { "type": "number", "format": "double" }, "type": "array", "description": "Quantiles to use for minimize-quantile-loss `optimization_objective`, or for probabilistic inference. Up to 5 quantiles are allowed of values between 0 and 1, exclusive. Required if the value of optimization_objective is minimize-quantile-loss. Represents the percent quantiles to use for that objective. Quantiles must be unique." }, "validationOptions": { "type": "string", "description": "Validation options for the data validation component. The available options are: * \"fail-pipeline\" - default, will validate against the validation and fail the pipeline if it fails. * \"ignore-validation\" - ignore the results of the validation and continue" }, "dataGranularity": { "description": "Expected difference in time granularity between rows in the data.", "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsGranularity" }, "additionalExperiments": { "description": "Additional experiment flags for the time series forcasting training.", "items": { "type": "string" }, "type": "array" }, "timeColumn": { "description": "The name of the column that identifies time order in the time series. This column must be available at forecast.", "type": "string" }, "optimizationObjective": { "description": "Objective function the model is optimizing towards. The training process creates a model that optimizes the value of the objective function over the validation set. The supported optimization objectives: * \"minimize-rmse\" (default) - Minimize root-mean-squared error (RMSE). * \"minimize-mae\" - Minimize mean-absolute error (MAE). * \"minimize-rmsle\" - Minimize root-mean-squared log error (RMSLE). * \"minimize-rmspe\" - Minimize root-mean-squared percentage error (RMSPE). * \"minimize-wape-mae\" - Minimize the combination of weighted absolute percentage error (WAPE) and mean-absolute-error (MAE). * \"minimize-quantile-loss\" - Minimize the quantile loss at the quantiles defined in `quantiles`. * \"minimize-mape\" - Minimize the mean absolute percentage error.", "type": "string" }, "enableProbabilisticInference": { "description": "If probabilistic inference is enabled, the model will fit a distribution that captures the uncertainty of a prediction. At inference time, the predictive distribution is used to make a point prediction that minimizes the optimization objective. For example, the mean of a predictive distribution is the point prediction that minimizes RMSE loss. If quantiles are specified, then the quantiles of the distribution are also returned. The optimization objective cannot be minimize-quantile-loss.", "type": "boolean" }, "timeSeriesIdentifierColumn": { "type": "string", "description": "The name of the column that identifies the time series." }, "windowConfig": { "description": "Config containing strategy for generating sliding windows.", "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionWindowConfig" }, "contextWindow": { "format": "int64", "description": "The amount of time into the past training and prediction data is used for model training and prediction respectively. Expressed in number of units defined by the `data_granularity` field.", "type": "string" }, "weightColumn": { "type": "string", "description": "Column name that should be used as the weight column. Higher values in this column give more importance to the row during model training. The column must have numeric values between 0 and 10000 inclusively; 0 means the row is ignored for training. If weight column field is not set, then all rows are assumed to have equal weight of 1." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputs" }, "GenaiVertexV1beta1VideoContentStaticMediaProcessing": { "properties": { "endOffset": { "description": "Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., \"30s\". Must be non-negative and greater than `start_offset` if `start_offset` is set.", "format": "google-duration", "type": "string" }, "fps": { "description": "Optional. Video frame-rate sampling density.", "type": "number", "format": "double" }, "startOffset": { "format": "google-duration", "type": "string", "description": "Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., \"10.5s\". Must be non-negative." } }, "id": "GenaiVertexV1beta1VideoContentStaticMediaProcessing", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaTextExtractionAnnotation": { "properties": { "annotationSpecId": { "description": "The resource Id of the AnnotationSpec that this Annotation pertains to.", "type": "string" }, "displayName": { "type": "string", "description": "The display name of the AnnotationSpec that this Annotation pertains to." }, "textSegment": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTextSegment", "description": "The segment of the text content." } }, "type": "object", "description": "Annotation details specific to text extraction.", "id": "GoogleCloudAiplatformV1beta1SchemaTextExtractionAnnotation" }, "GoogleCloudAiplatformV1beta1DestinationFeatureSetting": { "id": "GoogleCloudAiplatformV1beta1DestinationFeatureSetting", "type": "object", "properties": { "destinationField": { "description": "Specify the field name in the export destination. If not specified, Feature ID is used.", "type": "string" }, "featureId": { "type": "string", "description": "Required. The ID of the Feature to apply the setting to." } } }, "GoogleCloudAiplatformV1beta1SchemaPredictPredictionTabularRegressionPredictionResult": { "description": "Prediction output format for Tabular Regression.", "properties": { "lowerBound": { "type": "number", "description": "The lower bound of the prediction interval.", "format": "float" }, "quantileValues": { "description": "Quantile values.", "type": "array", "items": { "format": "float", "type": "number" } }, "quantilePredictions": { "type": "array", "description": "Quantile predictions, in 1-1 correspondence with quantile_values.", "items": { "type": "number", "format": "float" } }, "upperBound": { "description": "The upper bound of the prediction interval.", "format": "float", "type": "number" }, "value": { "description": "The regression value.", "type": "number", "format": "float" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaPredictPredictionTabularRegressionPredictionResult" }, "GoogleCloudAiplatformV1beta1CacheConfig": { "id": "GoogleCloudAiplatformV1beta1CacheConfig", "description": "Config of GenAI caching features. This is a singleton resource.", "properties": { "name": { "description": "Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.", "type": "string" }, "disableCache": { "type": "boolean", "description": "If set to true, disables GenAI caching. Otherwise caching is enabled." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1VideoResponseFormat": { "properties": { "aspectRatio": { "type": "string", "description": "The aspect ratio for the video output.", "enum": [ "ASPECT_RATIO_UNSPECIFIED", "ASPECT_RATIO_SIXTEEN_BY_NINE", "ASPECT_RATIO_NINE_BY_SIXTEEN" ], "enumDescriptions": [ "Default value. This value is unused.", "16:9 aspect ratio.", "9:16 aspect ratio." ] }, "delivery": { "enumDescriptions": [ "Default value. This value is unused.", "Generated bytes are returned inline in the response.", "Generated content is stored and a URI is returned." ], "enum": [ "DELIVERY_UNSPECIFIED", "INLINE", "URI" ], "type": "string", "description": "Optional. Delivery mode for the generated content." }, "gcsUri": { "description": "Optional. The Google Cloud Storage URI to store the video output. Required for Vertex if delivery is URI.", "type": "string" }, "resolution": { "description": "Optional. The video output resolution. Supported values: \"360p\", \"720p\", \"1080p\", \"4k\".", "type": "string" }, "duration": { "type": "string", "format": "google-duration", "description": "Optional. The duration for the video output." } }, "id": "GoogleCloudAiplatformV1beta1VideoResponseFormat", "description": "Configuration for video-specific output formatting.", "type": "object" }, "GoogleCloudAiplatformV1beta1FeatureViewOptimizedConfig": { "description": "Configuration for FeatureViews created in Optimized FeatureOnlineStore.", "type": "object", "properties": { "automaticResources": { "$ref": "GoogleCloudAiplatformV1beta1AutomaticResources", "description": "Optional. A description of resources that the FeatureView uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2. If max_replica_count is not set, the default value is 6. The max allowed replica count is 1000." } }, "id": "GoogleCloudAiplatformV1beta1FeatureViewOptimizedConfig" }, "GoogleCloudAiplatformV1beta1TrajectorySingleToolUseResults": { "type": "object", "properties": { "trajectorySingleToolUseMetricValues": { "description": "Output only. TrajectorySingleToolUse metric values.", "type": "array", "readOnly": true, "items": { "$ref": "GoogleCloudAiplatformV1beta1TrajectorySingleToolUseMetricValue" } } }, "description": "Results for TrajectorySingleToolUse metric.", "id": "GoogleCloudAiplatformV1beta1TrajectorySingleToolUseResults" }, "GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata": { "type": "object", "id": "GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata", "description": "Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics.", "properties": { "totalTokenCount": { "format": "int32", "description": "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`.", "type": "integer" }, "cachedContentTokenCount": { "format": "int32", "description": "Output only. The number of tokens in the cached content that was used for this request.", "readOnly": true, "type": "integer" }, "candidatesTokenCount": { "type": "integer", "format": "int32", "description": "The total number of tokens in the generated candidates." }, "cacheTokensDetails": { "readOnly": true, "type": "array", "description": "Output only. A detailed breakdown of the token count for each modality in the cached content.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" } }, "promptTokensDetails": { "description": "Output only. A detailed breakdown of the token count for each modality in the prompt.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" }, "readOnly": true }, "thoughtsTokenCount": { "format": "int32", "type": "integer", "readOnly": true, "description": "Output only. The number of tokens that were part of the model's generated \"thoughts\" output, if applicable." }, "toolUsePromptTokensDetails": { "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" }, "description": "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." }, "toolUsePromptTokenCount": { "readOnly": true, "format": "int32", "type": "integer", "description": "Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable." }, "candidatesTokensDetails": { "items": { "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" }, "readOnly": true, "type": "array", "description": "Output only. A detailed breakdown of the token count for each modality in the generated candidates." }, "trafficType": { "readOnly": true, "type": "string", "description": "Output only. The traffic type for this request.", "enumDescriptions": [ "Unspecified request traffic type.", "The request was processed using Pay-As-You-Go quota.", "Type for Priority Pay-As-You-Go traffic.", "Type for Flex traffic.", "Type for Off-Peak Pay-As-You-Go traffic.", "Type for Provisioned Throughput traffic." ], "enum": [ "TRAFFIC_TYPE_UNSPECIFIED", "ON_DEMAND", "ON_DEMAND_PRIORITY", "ON_DEMAND_FLEX", "ON_DEMAND_OFFPEAK", "PROVISIONED_THROUGHPUT" ] }, "promptTokenCount": { "description": "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.", "format": "int32", "type": "integer" } } }, "GoogleCloudAiplatformV1beta1MemoryConjunctionFilter": { "id": "GoogleCloudAiplatformV1beta1MemoryConjunctionFilter", "description": "A conjunction of filters that will be combined using AND logic.", "properties": { "filters": { "items": { "$ref": "GoogleCloudAiplatformV1beta1MemoryFilter" }, "type": "array", "description": "Represents filters that will be combined using AND logic." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1RetrieveContextsRequest": { "description": "Request message for VertexRagService.RetrieveContexts.", "id": "GoogleCloudAiplatformV1beta1RetrieveContextsRequest", "type": "object", "properties": { "vertexRagStore": { "$ref": "GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStore", "description": "The data source for Vertex RagStore." }, "query": { "description": "Required. Single RAG retrieve query.", "$ref": "GoogleCloudAiplatformV1beta1RagQuery" } } }, "GoogleCloudAiplatformV1beta1ServingProfileCmekConfig": { "properties": { "encryptionSpec": { "description": "Required. The customer-managed encryption key spec for the Serving Profile.", "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec" } }, "id": "GoogleCloudAiplatformV1beta1ServingProfileCmekConfig", "description": "Configuration for Customer-Managed Encryption Keys (CMEK).", "type": "object" }, "GoogleCloudAiplatformV1beta1ListDeploymentResourcePoolsResponse": { "properties": { "deploymentResourcePools": { "description": "The DeploymentResourcePools from the specified location.", "items": { "$ref": "GoogleCloudAiplatformV1beta1DeploymentResourcePool" }, "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object", "description": "Response message for ListDeploymentResourcePools method.", "id": "GoogleCloudAiplatformV1beta1ListDeploymentResourcePoolsResponse" }, "GoogleCloudAiplatformV1beta1AgentTool": { "description": "A tool provides a list of actions available to the Agent during the process of executing a task.", "properties": { "type": { "description": "Required. The type of the tool. Supported types: * `code_execution` * `endpoint` * `filesystem` * `google_search` * `mcp_server` * `url_context`", "type": "string" }, "url": { "description": "Optional. Temporary: the tool's runtime reference, consumed by CreateAgent to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`. It is duplicated here (the resource name is already in `name`) only because the Agent service is not yet connected to Agent Registry to derive it from `name`; the Task Service instead resolves it from Agent Registry (GetMcpServer / GetEndpoint) at task creation.", "type": "string" }, "headers": { "type": "object", "description": "Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`.", "additionalProperties": { "type": "string" } }, "name": { "type": "string", "description": "Optional. The tool's GCP resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`." } }, "id": "GoogleCloudAiplatformV1beta1AgentTool", "type": "object" }, "GoogleCloudAiplatformV1beta1ExportFeatureValuesResponse": { "id": "GoogleCloudAiplatformV1beta1ExportFeatureValuesResponse", "properties": {}, "type": "object", "description": "Response message for FeaturestoreService.ExportFeatureValues." }, "GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingInstance": { "description": "Instance for RubricBasedInstructionFollowing metric - one instance corresponds to one row in an evaluation dataset.", "id": "GoogleCloudAiplatformV1beta1RubricBasedInstructionFollowingInstance", "properties": { "jsonInstance": { "description": "Required. Instance specified as a json string. String key-value pairs are expected in the json_instance to render RubricBasedInstructionFollowing prompt templates.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaPromptSpecPromptMessage": { "type": "object", "properties": { "toolConfig": { "description": "Tool config. This config is shared for all tools provided in the request.", "$ref": "GoogleCloudAiplatformV1beta1ToolConfig" }, "model": { "description": "The model name.", "type": "string" }, "systemInstruction": { "$ref": "GoogleCloudAiplatformV1beta1Content", "description": "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." }, "contents": { "type": "array", "description": "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.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" } }, "tools": { "type": "array", "description": "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.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Tool" } }, "safetySettings": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1SafetySetting" }, "description": "Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates." }, "generationConfig": { "description": "Generation config.", "$ref": "GoogleCloudAiplatformV1beta1GenerationConfig" } }, "id": "GoogleCloudAiplatformV1beta1SchemaPromptSpecPromptMessage", "description": "The prompt message that aligns with the prompt message in google.cloud.aiplatform.master.GenerateContentRequest." }, "GoogleCloudAiplatformV1beta1ProcessDataRequest": { "properties": { "outputBucketProjectNumber": { "description": "Optional. The project number of the project that the user expects to own the output Cloud Storage bucket referenced by gcs_destination. The service verifies that the bucket is actually owned by this project before writing to it, in order to prevent bucket squatting. If unset, the bucket is verified to be owned by the project the request is made for (parent).", "format": "int64", "type": "string" }, "gcsSource": { "description": "Optional. A JSONL file containing a list of files to process stored in the user's GCS bucket.", "$ref": "GoogleCloudAiplatformV1beta1GcsSource" }, "veoSpec": { "description": "Optional. Spec for Veo data processing.", "$ref": "GoogleCloudAiplatformV1beta1ProcessDataRequestVeoSpec" }, "gcsDestination": { "description": "Optional. The GCS bucket to store the processed videos and captions data.", "$ref": "GoogleCloudAiplatformV1beta1GcsDestination" }, "inputBucketProjectNumber": { "format": "int64", "description": "Optional. The project number of the project that the user expects to own the input Cloud Storage bucket referenced by gcs_source. The service verifies that the bucket is actually owned by this project before reading from it, in order to prevent bucket squatting. If unset, the bucket is verified to be owned by the project the request is made for (parent).", "type": "string" } }, "description": "Request message for GenAiTuningService.ProcessData.", "id": "GoogleCloudAiplatformV1beta1ProcessDataRequest", "type": "object" }, "GoogleCloudAiplatformV1beta1GenerateUserScenariosResponse": { "type": "object", "properties": { "userScenarios": { "items": { "$ref": "GoogleCloudAiplatformV1beta1UserScenario" }, "type": "array", "description": "The generated user scenarios used to simulate multi-turn agent running results and agent evaluation." } }, "description": "Response message for DataFoundryService.GenerateUserScenarios.", "id": "GoogleCloudAiplatformV1beta1GenerateUserScenariosResponse" }, "GenaiVertexV1beta1FunctionResultContent": { "id": "GenaiVertexV1beta1FunctionResultContent", "description": "A function tool result content block.", "deprecated": true, "type": "object", "properties": { "name": { "type": "string", "description": "The name of the tool that was called." }, "stringResult": { "type": "string" }, "contentList": { "$ref": "GenaiVertexV1beta1FunctionResultSubcontentList" }, "structResult": { "$ref": "GenaiVertexV1beta1Struct" }, "isError": { "type": "boolean", "description": "Whether the tool call resulted in an error." } } }, "GoogleCloudAiplatformV1beta1ExamplesExampleGcsSource": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ExamplesExampleGcsSource", "properties": { "gcsSource": { "$ref": "GoogleCloudAiplatformV1beta1GcsSource", "description": "The Cloud Storage location for the input instances." }, "dataFormat": { "enum": [ "DATA_FORMAT_UNSPECIFIED", "JSONL" ], "enumDescriptions": [ "Format unspecified, used when unset.", "Examples are stored in JSONL files." ], "type": "string", "description": "The format in which instances are given, if not specified, assume it's JSONL format. Currently only JSONL format is supported." } }, "description": "The Cloud Storage input instances." }, "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsSummarizationEvaluationMetrics": { "id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsSummarizationEvaluationMetrics", "type": "object", "properties": { "rougeLSum": { "type": "number", "description": "ROUGE-L (Longest Common Subsequence) scoring at summary level.", "format": "float" } } }, "GenaiVertexV1beta1AudioContent": { "type": "object", "description": "An audio content block. ", "properties": { "sampleRate": { "description": "The sample rate of the audio.", "type": "integer", "format": "int32" }, "mimeTypeString": { "type": "string", "description": "Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the \"mime_type\" JSON key." }, "data": { "description": "The audio content.", "type": "string", "format": "byte" }, "channels": { "format": "int32", "type": "integer", "description": "The number of audio channels." }, "uri": { "type": "string", "description": "The URI of the audio." } }, "id": "GenaiVertexV1beta1AudioContent" }, "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig": { "id": "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveConfigTrainingPredictionSkewDetectionConfig", "type": "object", "properties": { "defaultSkewThreshold": { "description": "Skew anomaly detection threshold used by all features. When the per-feature thresholds are not set, this field can be used to specify a threshold for all features.", "$ref": "GoogleCloudAiplatformV1beta1ThresholdConfig" }, "attributionScoreSkewThresholds": { "description": "Key is the feature name and value is the threshold. The threshold here is against attribution score distance between the training and prediction feature.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1ThresholdConfig" } }, "skewThresholds": { "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1ThresholdConfig" }, "description": "Key is the feature name and value is the threshold. If a feature needs to be monitored for skew, a value threshold must be configured for that feature. The threshold here is against feature distribution distance between the training and prediction feature.", "type": "object" } }, "description": "The config for Training & Prediction data skew detection. It specifies the training dataset sources and the skew detection parameters." }, "GoogleCloudAiplatformV1beta1DeployRequestEndpointConfig": { "id": "GoogleCloudAiplatformV1beta1DeployRequestEndpointConfig", "description": "The endpoint config to use for the deployment.", "properties": { "labels": { "additionalProperties": { "type": "string" }, "description": "Optional. The labels with user-defined metadata to organize your Endpoints. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.", "type": "object" }, "endpointDisplayName": { "type": "string", "description": "Optional. The user-specified display name of the endpoint. If not set, a default name will be used." }, "endpointUserId": { "type": "string", "description": "Optional. Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body." }, "privateServiceConnectConfig": { "description": "Optional. Configuration for private service connect. If set, the endpoint will be exposed through private service connect.", "$ref": "GoogleCloudAiplatformV1beta1PrivateServiceConnectConfig" }, "dedicatedEndpointDisabled": { "description": "Optional. By default, if dedicated endpoint is enabled and private service connect config is not set, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. If private service connect config is set, the endpoint will be exposed through private service connect. 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. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region}-aiplatform.googleapis.com.", "type": "boolean" }, "dedicatedEndpointEnabled": { "type": "boolean", "description": "Optional. Deprecated. Use dedicated_endpoint_disabled instead. 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.", "deprecated": true } }, "type": "object" }, "GoogleCloudAiplatformV1beta1Examples": { "properties": { "neighborCount": { "description": "The number of neighbors to return when querying for examples.", "type": "integer", "format": "int32" }, "presets": { "$ref": "GoogleCloudAiplatformV1beta1Presets", "description": "Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality." }, "nearestNeighborSearchConfig": { "description": "The full configuration for the generated index, the semantics are the same as metadata and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).", "type": "any" }, "gcsSource": { "description": "The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.", "$ref": "GoogleCloudAiplatformV1beta1GcsSource" }, "exampleGcsSource": { "$ref": "GoogleCloudAiplatformV1beta1ExamplesExampleGcsSource", "description": "The Cloud Storage input instances." } }, "description": "Example-based explainability that returns the nearest neighbors from the provided dataset.", "id": "GoogleCloudAiplatformV1beta1Examples", "type": "object" }, "GoogleCloudAiplatformV1beta1Measurement": { "id": "GoogleCloudAiplatformV1beta1Measurement", "description": "A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values.", "type": "object", "properties": { "stepCount": { "type": "string", "description": "Output only. The number of steps the machine learning model has been trained for. Must be non-negative.", "format": "int64", "readOnly": true }, "elapsedDuration": { "type": "string", "readOnly": true, "description": "Output only. Time that the Trial has been running at the point of this Measurement.", "format": "google-duration" }, "metrics": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1MeasurementMetric" }, "description": "Output only. A list of metrics got by evaluating the objective functions using suggested Parameter values.", "readOnly": true } } }, "GoogleCloudAiplatformV1beta1DistillationSpec": { "properties": { "tuningMode": { "description": "Optional. Specifies the tuning mode for distillation (sft part). This feature is only available for open source models.", "enum": [ "TUNING_MODE_UNSPECIFIED", "TUNING_MODE_FULL", "TUNING_MODE_PEFT_ADAPTER" ], "type": "string", "enumDescriptions": [ "Tuning mode is unspecified.", "Full fine-tuning mode.", "PEFT adapter tuning mode." ] }, "hyperParameters": { "$ref": "GoogleCloudAiplatformV1beta1DistillationHyperParameters", "description": "Optional. Hyperparameters for Distillation." }, "studentModel": { "type": "string", "description": "The student model that is being tuned, e.g., \"google/gemma-2b-1.1-it\". Deprecated. Use base_model instead.", "deprecated": true }, "baseTeacherModel": { "type": "string", "description": "The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models)." }, "tunedTeacherModelSource": { "type": "string", "description": "The resource name of the Tuned teacher model. Format: `projects/{project}/locations/{location}/models/{model}`." }, "promptDatasetUri": { "description": "Optional. Cloud Storage path to file containing prompt dataset for distillation. The dataset must be formatted as a JSONL file.", "type": "string" }, "validationDatasetUri": { "type": "string", "description": "Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file." }, "trainingDatasetUri": { "description": "Deprecated. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file.", "deprecated": true, "type": "string" }, "pipelineRootDirectory": { "description": "Deprecated. A path in a Cloud Storage bucket, which will be treated as the root output directory of the distillation pipeline. It is used by the system to generate the paths of output artifacts.", "deprecated": true, "type": "string" } }, "description": "Tuning Spec for Distillation.", "id": "GoogleCloudAiplatformV1beta1DistillationSpec", "type": "object" }, "GoogleCloudAiplatformV1beta1StreamRawPredictRequest": { "type": "object", "id": "GoogleCloudAiplatformV1beta1StreamRawPredictRequest", "properties": { "httpBody": { "$ref": "GoogleApiHttpBody", "description": "The prediction input. Supports HTTP headers and arbitrary data payload." } }, "description": "Request message for PredictionService.StreamRawPredict." }, "GoogleCloudAiplatformV1beta1ResumeScheduleRequest": { "description": "Request message for ScheduleService.ResumeSchedule.", "id": "GoogleCloudAiplatformV1beta1ResumeScheduleRequest", "properties": { "catchUp": { "description": "Optional. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. This will also update Schedule.catch_up field. Default to false.", "type": "boolean" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsClassificationEvaluationMetrics": { "description": "Metrics for classification evaluation results.", "properties": { "auRoc": { "description": "The Area Under Receiver Operating Characteristic curve metric. Micro-averaged for the overall evaluation.", "format": "float", "type": "number" }, "confusionMatrix": { "$ref": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsConfusionMatrix", "description": "Confusion matrix of the evaluation." }, "logLoss": { "description": "The Log Loss metric.", "format": "float", "type": "number" }, "confidenceMetrics": { "description": "Metrics for each `confidenceThreshold` in 0.00,0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and `positionThreshold` = INT32_MAX_VALUE. ROC and precision-recall curves, and other aggregated metrics are derived from them. The confidence metrics entries may also be supplied for additional values of `positionThreshold`, but from these no aggregated metrics are computed.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsClassificationEvaluationMetricsConfidenceMetrics" } }, "auPrc": { "type": "number", "description": "The Area Under Precision-Recall Curve metric. Micro-averaged for the overall evaluation.", "format": "float" } }, "id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsClassificationEvaluationMetrics", "type": "object" }, "GoogleCloudAiplatformV1beta1BidiExecuteSandboxEnvironmentResponse": { "type": "object", "id": "GoogleCloudAiplatformV1beta1BidiExecuteSandboxEnvironmentResponse", "properties": { "outputs": { "type": "array", "description": "The outputs from the sandbox environment.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Chunk" } } }, "description": "Response message for SandboxEnvironmentExecutionService.BidiExecuteSandboxEnvironment." }, "GoogleCloudAiplatformV1beta1MigrateResourceRequestMigrateMlEngineModelVersionConfig": { "type": "object", "description": "Config for migrating version in ml.googleapis.com to Vertex AI's Model.", "properties": { "modelVersion": { "type": "string", "description": "Required. Full resource name of ml engine model version. Format: `projects/{project}/models/{model}/versions/{version}`." }, "modelDisplayName": { "description": "Required. Display name of the model in Vertex AI. System will pick a display name if unspecified.", "type": "string" }, "endpoint": { "description": "Required. The ml.googleapis.com endpoint that this model version should be migrated from. Example values: * ml.googleapis.com * us-centrall-ml.googleapis.com * europe-west4-ml.googleapis.com * asia-east1-ml.googleapis.com", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1MigrateResourceRequestMigrateMlEngineModelVersionConfig" }, "GoogleCloudAiplatformV1beta1CustomJobSpec": { "description": "Represents the spec of a CustomJob.", "type": "object", "id": "GoogleCloudAiplatformV1beta1CustomJobSpec", "properties": { "tensorboard": { "type": "string", "description": "Optional. The name of a Vertex AI Tensorboard resource to which this CustomJob will upload Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`" }, "enableWebAccess": { "type": "boolean", "description": "Optional. Whether you want Vertex AI to enable [interactive shell access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) to training containers. If set to `true`, you can access interactive shells at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials)." }, "pscInterfaceConfig": { "description": "Optional. Configuration for PSC-I for CustomJob.", "$ref": "GoogleCloudAiplatformV1beta1PscInterfaceConfig" }, "network": { "description": "Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the job is not peered with any network.", "type": "string" }, "experimentRun": { "description": "Optional. The Experiment Run associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}`", "type": "string" }, "workerPoolSpecs": { "description": "Required. The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1WorkerPoolSpec" } }, "persistentResourceId": { "type": "string", "description": "Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected." }, "protectedArtifactLocationId": { "type": "string", "description": "The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations" }, "baseOutputDirectory": { "$ref": "GoogleCloudAiplatformV1beta1GcsDestination", "description": "The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. For HyperparameterTuningJob, the baseOutputDirectory of each child CustomJob backing a Trial is set to a subdirectory of name id under its parent HyperparameterTuningJob's baseOutputDirectory. The following Vertex AI environment variables will be passed to containers or python modules when this field is set: For CustomJob: * AIP_MODEL_DIR = `/model/` * AIP_CHECKPOINT_DIR = `/checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `/logs/` For CustomJob backing a Trial of HyperparameterTuningJob: * AIP_MODEL_DIR = `//model/` * AIP_CHECKPOINT_DIR = `//checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `//logs/`" }, "experiment": { "type": "string", "description": "Optional. The Experiment associated with this job. Format: `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}`" }, "scheduling": { "description": "Scheduling options for a CustomJob.", "$ref": "GoogleCloudAiplatformV1beta1Scheduling" }, "serviceAccount": { "description": "Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.", "type": "string" }, "enableDashboardAccess": { "type": "boolean", "description": "Optional. Whether you want Vertex AI to enable access to the customized dashboard in training chief container. If set to `true`, you can access the dashboard at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials)." }, "models": { "type": "array", "items": { "type": "string" }, "description": "Optional. The name of the Model resources for which to generate a mapping to artifact URIs. Applicable only to some of the Google-provided custom jobs. Format: `projects/{project}/locations/{location}/models/{model}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the \"default\" version will be returned. The \"default\" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version." }, "reservedIpRanges": { "type": "array", "items": { "type": "string" }, "description": "Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']." } } }, "GoogleCloudAiplatformV1beta1AuthConfigGoogleServiceAccountConfig": { "properties": { "serviceAccount": { "description": "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.", "type": "string" } }, "description": "Config for Google Service Account Authentication.", "id": "GoogleCloudAiplatformV1beta1AuthConfigGoogleServiceAccountConfig", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry": { "properties": { "recall": { "description": "Recall (True Positive Rate) for the given confidence threshold.", "format": "float", "type": "number" }, "precision": { "type": "number", "description": "Precision for the given confidence threshold.", "format": "float" }, "iouScore": { "format": "float", "description": "The intersection-over-union score. The measure of overlap of the annotation's category mask with ground truth category mask on the DataItem.", "type": "number" }, "confusionMatrix": { "description": "Confusion matrix for the given confidence threshold.", "$ref": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsConfusionMatrix" }, "confidenceThreshold": { "format": "float", "type": "number", "description": "Metrics are computed with an assumption that the model never returns predictions with score lower than this value." }, "diceScoreCoefficient": { "type": "number", "description": "DSC or the F1 score, The harmonic mean of recall and precision.", "format": "float" } }, "id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry", "type": "object" }, "GenaiVertexV1beta1SpeakerConfig": { "id": "GenaiVertexV1beta1SpeakerConfig", "description": "Configuration for multi-speaker and speech generation.", "properties": { "speakers": { "type": "array", "items": { "$ref": "GenaiVertexV1beta1SpeechConfig" }, "description": "Individual speaker configurations." } }, "type": "object" }, "GenaiVertexV1beta1GoogleMaps": { "description": "A tool that can be used by the model to call Google Maps.", "properties": { "enableWidget": { "type": "boolean", "description": "Whether to return a widget context token in the tool call result of the response." }, "latitude": { "description": "The latitude of the user's location.", "type": "number", "format": "double" }, "longitude": { "description": "The longitude of the user's location.", "type": "number", "format": "double" } }, "id": "GenaiVertexV1beta1GoogleMaps", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaTimeSeriesDatasetMetadataInputConfig": { "type": "object", "description": "The time series Dataset's data source. The Dataset doesn't store the data directly, but only pointer(s) to its data.", "id": "GoogleCloudAiplatformV1beta1SchemaTimeSeriesDatasetMetadataInputConfig", "properties": { "bigquerySource": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTimeSeriesDatasetMetadataBigQuerySource" }, "gcsSource": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTimeSeriesDatasetMetadataGcsSource" } } }, "GenaiVertexV1beta1FileSearchCallDelta": { "properties": {}, "id": "GenaiVertexV1beta1FileSearchCallDelta", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity": { "properties": { "unit": { "description": "The time granularity unit of this time period. The supported units are: * \"minute\" * \"hour\" * \"day\" * \"week\" * \"month\" * \"year\"", "type": "string" }, "quantity": { "format": "int64", "type": "string", "description": "The number of granularity_units between data points in the training data. If `granularity_unit` is `minute`, can be 1, 5, 10, 15, or 30. For all other values of `granularity_unit`, must be 1." } }, "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsGranularity", "type": "object", "description": "A duration of time expressed in time granularity units." }, "GoogleCloudAiplatformV1beta1ModelEvaluationSliceSliceSliceSpecValue": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ModelEvaluationSliceSliceSliceSpecValue", "description": "Single value that supports strings and floats.", "properties": { "floatValue": { "format": "float", "description": "Float type.", "type": "number" }, "stringValue": { "description": "String type.", "type": "string" } } }, "CloudAiLargeModelsVisionGenerateVideoExperiments": { "description": "Experimental parameters for video generation.", "type": "object", "id": "CloudAiLargeModelsVisionGenerateVideoExperiments", "properties": { "modelEndpointOverride": { "description": "Optional. BNS override for model backend. Enabled only for local and autopush environments by the flag `lvm_allow_model_zoo_bns_override`.", "type": "string" }, "omniRewriter": { "$ref": "CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig", "description": "Optional. Omni Rewriter configuration." }, "customParameters": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Generic key-value pairs for experimental parameters. This allows adding new parameters without changing the dataplane binary.", "type": "object" }, "colorAlignment": { "$ref": "CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig", "description": "Optional. Color alignment configuration." }, "spatialAlignment": { "description": "Optional. Spatial alignment configuration.", "$ref": "CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig" }, "exrColorSpaceOverride": { "type": "string", "description": "Optional. Colorspace to be used for all EXR inputs." }, "modelName": { "description": "Model names, as defined in: xyz ", "type": "string" }, "videoTransformMaskGcsUri": { "description": "GCS URI of the grayscale video mask for Differential Diffusion. Maps to sdedit_video_tmax_scale_map ", "type": "string", "deprecated": true }, "audioControl": { "$ref": "CloudAiLargeModelsVisionGenerateVideoExperimentsAudioControlConfig", "description": "Optional. Audio control configuration." }, "anchorLastFrame": { "description": "Optional. If true, anchors the last frame in video generation by generating a custom border mask.", "type": "boolean" }, "videoTransformStrength": { "deprecated": true, "type": "number", "format": "float", "description": "SDEdit: Scalar noise level (0.0 to 1.0) Maps to sdedit_tmax " }, "videoTransform": { "$ref": "CloudAiLargeModelsVisionGenerateVideoExperimentsVideoTransform", "description": "Video transform configuration for omni editing models." }, "schedulingConfig": { "$ref": "CloudAiLargeModelsVisionGenerateVideoExperimentsVESchedulingConfig", "description": "Optional. Scheduling configuration." }, "outpaintConfig": { "description": "Config for Outpainting task.", "$ref": "CloudAiLargeModelsVisionGenerateVideoExperimentsOutpaintConfig" }, "promptInputs": { "$ref": "CloudAiLargeModelsVisionPromptInputs", "description": "Prompt chunks for \"ProModel\" prompting. If set, the prompt will not be rewritten, and top-level prompt ignored." }, "originalRequestJson": { "type": "string", "description": "The original REST API request JSON sent by the user, in the instances/parameters format. Preserved for saving alongside output artifacts so users can reproduce their requests. This field is populated by the API handler and is not user-settable." }, "numDiffusionSteps": { "description": "Number of diffusion steps", "format": "int32", "type": "integer" }, "seamless": { "$ref": "CloudAiLargeModelsVisionSeamless", "description": "Parameters for seamless (edge-continuous) video generation, enabling temporal looping and/or spatial tessellation." }, "codec": { "description": "Optional. Video codec to use for output.", "type": "string", "enumDescriptions": [ "", "", "", "" ], "enum": [ "VIDEO_CODEC_UNSPECIFIED", "VIDEO_CODEC_H264", "VIDEO_CODEC_PRORES", "VIDEO_CODEC_DNXHR" ] }, "truncateInputVideo": { "description": "If true (default), truncate input videos that exceed the model's maximum frame count by applying a frame_selection_config to __video_file__ inputs. Set to false to preserve the existing fail-fast behavior.", "type": "boolean" }, "conditioningFrames": { "description": "Conditioning frames for veo experimental models ONLY, not to be confused with keyframes (ID:31) in GenerateVideoRequest.", "type": "array", "items": { "$ref": "CloudAiLargeModelsVisionGenerateVideoExperimentsConditioningFrame" } }, "humanPose": { "description": "Human pose parameters for Pose Control", "$ref": "CloudAiLargeModelsVisionHumanPose" }, "requestOriginTag": { "description": "Optional tag for tracking the source of this request. Allowed values: \"colab\", \"comfyui\", \"curl\", \"flowresearch\", \"vertexstudio\". Unrecognized tags are recorded as \"unknown\" in metrics. Tags do not affect video generation behavior. Up to 16 characters, ASCII alphanumeric, hyphens, and underscores only.", "type": "string" }, "cfgScale": { "format": "float", "description": "CFG scale for video-transform, perf-generation, a2v, video-textures models.", "type": "number" } } }, "GoogleCloudAiplatformV1beta1UpdateExplanationDatasetResponse": { "id": "GoogleCloudAiplatformV1beta1UpdateExplanationDatasetResponse", "description": "Response message of ModelService.UpdateExplanationDataset operation.", "properties": {}, "type": "object" }, "GenaiVertexV1beta1FunctionCallContent": { "type": "object", "description": "A function tool call content block.", "id": "GenaiVertexV1beta1FunctionCallContent", "deprecated": true, "properties": { "arguments": { "description": "Required. The arguments to pass to the function.", "$ref": "GenaiVertexV1beta1Struct" }, "name": { "type": "string", "description": "Required. The name of the tool to call." } } }, "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveSpec": { "id": "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveSpec", "description": "Monitoring objectives spec.", "type": "object", "properties": { "targetDataset": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringInput", "description": "Target dataset." }, "tabularObjective": { "description": "Tabular monitoring objective.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveSpecTabularObjective" }, "baselineDataset": { "description": "Baseline dataset. It could be the training dataset or production serving dataset from a previous period.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringInput" }, "explanationSpec": { "description": "The explanation spec. This spec is required when the objectives spec includes feature attribution objectives.", "$ref": "GoogleCloudAiplatformV1beta1ExplanationSpec" } } }, "GoogleCloudAiplatformV1beta1UpdateEndpointLongRunningRequest": { "properties": { "endpoint": { "description": "Required. The Endpoint which replaces the resource on the server. Currently we only support updating the `client_connection_config` field, all the other fields' update will be blocked.", "$ref": "GoogleCloudAiplatformV1beta1Endpoint" } }, "id": "GoogleCloudAiplatformV1beta1UpdateEndpointLongRunningRequest", "type": "object", "description": "Request message for EndpointService.UpdateEndpointLongRunning." }, "GoogleCloudAiplatformV1beta1ListMonitoredAgentsResponse": { "properties": { "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "monitoredAgents": { "description": "A list of MonitoredAgents that matches the specified filter in the request.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1MonitoredAgent" } }, "totalSize": { "type": "integer", "description": "The total number of MonitoredAgents matching the request, after any `filter` is applied.", "format": "int32" } }, "type": "object", "description": "Response message for AgentAnomalyDetectionService.ListMonitoredAgents.", "id": "GoogleCloudAiplatformV1beta1ListMonitoredAgentsResponse" }, "GoogleCloudAiplatformV1beta1ModelMonitoringInputBatchPredictionOutput": { "properties": { "batchPredictionJob": { "type": "string", "description": "Vertex AI Batch prediction job resource name. The job must match the model version specified in [ModelMonitor].[model_monitoring_target]." } }, "id": "GoogleCloudAiplatformV1beta1ModelMonitoringInputBatchPredictionOutput", "description": "Data from Vertex AI Batch prediction job output.", "type": "object" }, "GoogleCloudAiplatformV1beta1FeatureOnlineStoreOptimized": { "type": "object", "properties": {}, "id": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreOptimized", "description": "Optimized storage type" }, "GoogleCloudAiplatformV1beta1CompactionConfigLlmSummarizationConfig": { "description": "Configuration for LLM summarization-based compaction. When set, the session context is summarized with an LLM once it exceeds the summarizer target threshold.", "properties": { "mode": { "enumDescriptions": [ "Unspecified. Requests must set an explicit mode.", "Platform-managed summarization with server-side defaults." ], "description": "Required. The summarization mode. Only `AUTO` is supported for MVP.", "enum": [ "MODE_UNSPECIFIED", "AUTO" ], "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1CompactionConfigLlmSummarizationConfig" }, "GoogleCloudAiplatformV1beta1ModelMonitor": { "description": "Vertex AI Model Monitoring Service serves as a central hub for the analysis and visualization of data quality and performance related to models. ModelMonitor stands as a top level resource for overseeing your model monitoring tasks.", "type": "object", "properties": { "modelMonitoringSchema": { "description": "Monitoring Schema is to specify the model's features, prediction outputs and ground truth properties. It is used to extract pertinent data from the dataset and to process features based on their properties. Make sure that the schema aligns with your dataset, if it does not, we will be unable to extract data from the dataset. It is required for most models, but optional for Vertex AI AutoML Tables unless the schem information is not available.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringSchema" }, "name": { "description": "Immutable. Resource name of the ModelMonitor. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`.", "type": "string" }, "explanationSpec": { "description": "Optional model explanation spec. It is used for feature attribution monitoring.", "$ref": "GoogleCloudAiplatformV1beta1ExplanationSpec" }, "outputSpec": { "description": "Optional default monitoring metrics/logs export spec, it can be overridden in the ModelMonitoringJob output spec. If not specified, a default Google Cloud Storage bucket will be created under your project.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringOutputSpec" }, "updateTime": { "description": "Output only. Timestamp when this ModelMonitor was updated most recently.", "readOnly": true, "type": "string", "format": "google-datetime" }, "modelMonitoringTarget": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitorModelMonitoringTarget", "description": "The entity that is subject to analysis. Currently only models in Vertex AI Model Registry are supported. If you want to analyze the model which is outside the Vertex AI, you could register a model in Vertex AI Model Registry using just a display name." }, "trainingDataset": { "description": "Optional training dataset used to train the model. It can serve as a reference dataset to identify changes in production.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringInput" }, "encryptionSpec": { "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec", "description": "Customer-managed encryption key spec for a ModelMonitor. If set, this ModelMonitor and all sub-resources of this ModelMonitor will be secured by this key." }, "notificationSpec": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringNotificationSpec", "description": "Optional default notification spec, it can be overridden in the ModelMonitoringJob notification spec." }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" }, "displayName": { "description": "The display name of the ModelMonitor. The name can be up to 128 characters long and can consist of any UTF-8.", "type": "string" }, "satisfiesPzi": { "readOnly": true, "description": "Output only. Reserved for future use.", "type": "boolean" }, "tabularObjective": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveSpecTabularObjective", "description": "Optional default tabular model monitoring objective." }, "createTime": { "description": "Output only. Timestamp when this ModelMonitor was created.", "format": "google-datetime", "readOnly": true, "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1ModelMonitor" }, "GoogleCloudAiplatformV1beta1TrajectorySingleToolUseSpec": { "id": "GoogleCloudAiplatformV1beta1TrajectorySingleToolUseSpec", "type": "object", "description": "Spec for TrajectorySingleToolUse metric - returns 1 if tool is present in the predicted trajectory, else 0.", "properties": { "toolName": { "description": "Required. Spec for tool name to be checked for in the predicted trajectory.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1RougeInput": { "description": "Input for rouge metric.", "id": "GoogleCloudAiplatformV1beta1RougeInput", "properties": { "instances": { "items": { "$ref": "GoogleCloudAiplatformV1beta1RougeInstance" }, "description": "Required. Repeated rouge instances.", "type": "array" }, "metricSpec": { "$ref": "GoogleCloudAiplatformV1beta1RougeSpec", "description": "Required. Spec for rouge score metric." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentDataTools": { "id": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentDataTools", "type": "object", "properties": { "tool": { "deprecated": true, "description": "Optional. List of tools: each tool can have multiple function declarations.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Tool" } } }, "description": "Deprecated: Use `agent_eval_data` instead. Represents a list of tools for an agent." }, "GenaiVertexV1beta1InteractionUsageGroundingToolCount": { "id": "GenaiVertexV1beta1InteractionUsageGroundingToolCount", "description": "The number of grounding tool counts.", "type": "object", "properties": { "type": { "enum": [ "TYPE_UNSPECIFIED", "GOOGLE_SEARCH", "GOOGLE_MAPS", "RETRIEVAL" ], "type": "string", "description": "The grounding tool type associated with the count.", "enumDescriptions": [ "Default value. This value is unused.", "Grounding with Google Web Search and Image Search, & Web Grounding for Enterprise.", "Grounding with Google Maps.", "Grounding with customer's data, for example, VertexAISearch." ] }, "count": { "type": "integer", "description": "The number of grounding tool counts.", "format": "int32" } } }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageClassification": { "description": "A TrainingJob that trains and uploads an AutoML Image Classification Model.", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageClassification", "type": "object", "properties": { "metadata": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata", "description": "The metadata information." }, "inputs": { "description": "The input parameters of this TrainingJob.", "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageClassificationInputs" } } }, "GenaiVertexV1beta1ProcessingCallStep": { "properties": {}, "description": "A server-initiated processing step for media analysis (e.g. video understanding).", "type": "object", "id": "GenaiVertexV1beta1ProcessingCallStep" }, "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsBoundingBoxMetrics": { "description": "Bounding box matching model metrics for a single intersection-over-union threshold and multiple label match confidence thresholds.", "id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsBoundingBoxMetrics", "properties": { "confidenceMetrics": { "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsBoundingBoxMetricsConfidenceMetrics" }, "type": "array", "description": "Metrics for each label-match confidence_threshold from 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99. Precision-recall curve is derived from them." }, "iouThreshold": { "type": "number", "format": "float", "description": "The intersection-over-union threshold value used to compute this metrics entry." }, "meanAveragePrecision": { "description": "The mean average precision, most often close to `auPrc`.", "type": "number", "format": "float" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1RubricContentProperty": { "type": "object", "id": "GoogleCloudAiplatformV1beta1RubricContentProperty", "description": "Defines criteria based on a specific property.", "properties": { "description": { "description": "Description of the property being evaluated. Example: \"The model's response is grammatically correct.\"", "type": "string" } } }, "GoogleCloudAiplatformV1beta1SummarizationHelpfulnessInstance": { "description": "Spec for summarization helpfulness instance.", "id": "GoogleCloudAiplatformV1beta1SummarizationHelpfulnessInstance", "type": "object", "properties": { "context": { "description": "Required. Text to be summarized.", "type": "string" }, "instruction": { "type": "string", "description": "Optional. Summarization prompt for LLM." }, "prediction": { "description": "Required. Output of the evaluated model.", "type": "string" }, "reference": { "description": "Optional. Ground truth used to compare against the prediction.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1CompactionConfigEventEditingConfig": { "description": "Configuration for event-history editing-based compaction. When set, the event history is rewritten in place using deterministic rules (e.g. truncating/masking oversized tool responses, stripping model thoughts).", "properties": { "mode": { "type": "string", "enum": [ "MODE_UNSPECIFIED", "AUTO" ], "enumDescriptions": [ "Unspecified. Requests must set an explicit mode.", "Platform-managed editing with server-side defaults (e.g. 5KB tool-response truncation threshold)." ], "description": "Required. The event-editing mode. Only `AUTO` is supported for MVP." } }, "id": "GoogleCloudAiplatformV1beta1CompactionConfigEventEditingConfig", "type": "object" }, "GoogleCloudAiplatformV1beta1PublisherModelDocumentation": { "description": "A named piece of documentation.", "properties": { "title": { "type": "string", "description": "Required. E.g., OVERVIEW, USE CASES, DOCUMENTATION, SDK & SAMPLES, JAVA, NODE.JS, etc.." }, "content": { "description": "Required. Content of this piece of document (in Markdown format).", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1PublisherModelDocumentation", "type": "object" }, "GenaiVertexV1beta1McpServerToolResultContent": { "type": "object", "properties": { "stringResult": { "type": "string" }, "structResult": { "$ref": "GenaiVertexV1beta1Struct" }, "name": { "description": "Name of the tool which is called for this specific tool call.", "type": "string" }, "serverName": { "type": "string", "description": "The name of the used MCP server." }, "contentList": { "$ref": "GenaiVertexV1beta1FunctionResultSubcontentList" } }, "description": "MCPServer tool result content.", "id": "GenaiVertexV1beta1McpServerToolResultContent" }, "GoogleCloudAiplatformV1beta1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition": { "id": "GoogleCloudAiplatformV1beta1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition", "type": "object", "description": "Represents the spec to match discrete values from parent parameter.", "properties": { "values": { "items": { "type": "number", "format": "double" }, "type": "array", "description": "Required. Matches values of the parent parameter of 'DISCRETE' type. All values must exist in `discrete_value_spec` of parent parameter. The Epsilon of the value matching is 1e-10." } } }, "GoogleCloudAiplatformV1beta1QueryExtensionResponse": { "id": "GoogleCloudAiplatformV1beta1QueryExtensionResponse", "type": "object", "properties": { "steps": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" }, "type": "array", "description": "Steps of extension or LLM interaction, can contain function call, function response, or text response. The last step contains the final response to the query." }, "failureMessage": { "type": "string", "description": "Failure message if any." } }, "description": "Response message for ExtensionExecutionService.QueryExtension." }, "GenaiVertexV1beta1ResponseFormatList": { "type": "object", "id": "GenaiVertexV1beta1ResponseFormatList", "properties": { "responseFormats": { "items": { "$ref": "GenaiVertexV1beta1ResponseFormat" }, "type": "array" } } }, "GoogleCloudAiplatformV1beta1MutateDeployedIndexResponse": { "properties": { "deployedIndex": { "description": "The DeployedIndex that had been updated in the IndexEndpoint.", "$ref": "GoogleCloudAiplatformV1beta1DeployedIndex" } }, "description": "Response message for IndexEndpointService.MutateDeployedIndex.", "type": "object", "id": "GoogleCloudAiplatformV1beta1MutateDeployedIndexResponse" }, "GoogleCloudAiplatformV1beta1ImageResponseFormat": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ImageResponseFormat", "description": "Configuration for image-specific output formatting.", "properties": { "imageSize": { "enumDescriptions": [ "Default value. This value is unused.", "512px image size.", "1K image size.", "2K image size.", "4K image size." ], "description": "Optional. The size of the image output.", "enum": [ "IMAGE_SIZE_UNSPECIFIED", "IMAGE_SIZE_FIVE_TWELVE", "IMAGE_SIZE_ONE_K", "IMAGE_SIZE_TWO_K", "IMAGE_SIZE_FOUR_K" ], "type": "string" }, "mimeType": { "type": "string", "description": "Optional. The MIME type of the image output.", "enumDescriptions": [ "Default value. This value is unused.", "JPEG image format." ], "enum": [ "MIME_TYPE_UNSPECIFIED", "IMAGE_JPEG" ] }, "delivery": { "description": "Optional. Delivery mode for the generated content.", "enum": [ "DELIVERY_UNSPECIFIED", "INLINE", "URI" ], "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "Generated bytes are returned inline in the response.", "Generated content is stored and a URI is returned." ] }, "aspectRatio": { "enumDescriptions": [ "Default value. This value is unused.", "1:1 aspect ratio.", "2:3 aspect ratio.", "3:2 aspect ratio.", "3:4 aspect ratio.", "4:3 aspect ratio.", "4:5 aspect ratio.", "5:4 aspect ratio.", "9:16 aspect ratio.", "16:9 aspect ratio.", "21:9 aspect ratio.", "1:8 aspect ratio.", "8:1 aspect ratio.", "1:4 aspect ratio.", "4:1 aspect ratio." ], "type": "string", "description": "Optional. The aspect ratio for the image output.", "enum": [ "ASPECT_RATIO_UNSPECIFIED", "ASPECT_RATIO_ONE_BY_ONE", "ASPECT_RATIO_TWO_BY_THREE", "ASPECT_RATIO_THREE_BY_TWO", "ASPECT_RATIO_THREE_BY_FOUR", "ASPECT_RATIO_FOUR_BY_THREE", "ASPECT_RATIO_FOUR_BY_FIVE", "ASPECT_RATIO_FIVE_BY_FOUR", "ASPECT_RATIO_NINE_BY_SIXTEEN", "ASPECT_RATIO_SIXTEEN_BY_NINE", "ASPECT_RATIO_TWENTY_ONE_BY_NINE", "ASPECT_RATIO_ONE_BY_EIGHT", "ASPECT_RATIO_EIGHT_BY_ONE", "ASPECT_RATIO_ONE_BY_FOUR", "ASPECT_RATIO_FOUR_BY_ONE" ] } } }, "GoogleCloudAiplatformV1beta1AssessDataRequestTuningValidationAssessmentConfig": { "description": "Configuration for the tuning validation assessment.", "properties": { "datasetUsage": { "enumDescriptions": [ "Default value. Should not be used.", "Supervised fine-tuning training dataset.", "Supervised fine-tuning validation dataset." ], "description": "Required. The dataset usage (e.g. training/validation).", "enum": [ "DATASET_USAGE_UNSPECIFIED", "SFT_TRAINING", "SFT_VALIDATION" ], "type": "string" }, "modelName": { "description": "Required. The name of the model used for tuning.", "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1AssessDataRequestTuningValidationAssessmentConfig" }, "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSourceEvent": { "id": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSourceEvent", "type": "object", "properties": { "content": { "$ref": "GoogleCloudAiplatformV1beta1Content", "description": "Required. Represents the content of the event." } }, "description": "A single conversation event." }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation": { "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTextTransformation", "description": "Training pipeline will perform following transformation functions. * The text as is--no change to case, punctuation, spelling, tense, and so on. * Convert the category name to a dictionary lookup index and generate an embedding for each index.", "type": "object", "properties": { "columnName": { "type": "string" } } }, "GoogleCloudAiplatformV1beta1TaskEventData": { "type": "object", "properties": { "stateChange": { "description": "Optional. A change in the task's state.", "$ref": "GoogleCloudAiplatformV1beta1TaskStateChange" }, "outputChange": { "description": "Optional. A change to the task's final outputs.", "$ref": "GoogleCloudAiplatformV1beta1TaskOutputChange" }, "metadataChange": { "description": "Optional. A change to the task's metadata.", "$ref": "GoogleCloudAiplatformV1beta1TaskMetadataChange" }, "statusDetailsChange": { "$ref": "GoogleCloudAiplatformV1beta1TaskStatusDetailsChange", "description": "Optional. A change to the framework-specific status details." } }, "description": "Data for a TaskEvent.", "id": "GoogleCloudAiplatformV1beta1TaskEventData" }, "GoogleCloudAiplatformV1beta1Retrieval": { "properties": { "vertexRagStore": { "description": "Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.", "$ref": "GoogleCloudAiplatformV1beta1VertexRagStore" }, "vertexAiSearch": { "description": "Set to use data source powered by Vertex AI Search.", "$ref": "GoogleCloudAiplatformV1beta1VertexAISearch" }, "disableAttribution": { "type": "boolean", "description": "Optional. Deprecated. This option is no longer supported.", "deprecated": true }, "externalApi": { "description": "Use data source powered by external API for grounding.", "$ref": "GoogleCloudAiplatformV1beta1ExternalApi" } }, "description": "Defines a retrieval tool that model can call to access external knowledge.", "type": "object", "id": "GoogleCloudAiplatformV1beta1Retrieval" }, "GoogleCloudAiplatformV1beta1DeployModelResponse": { "id": "GoogleCloudAiplatformV1beta1DeployModelResponse", "properties": { "deployedModel": { "description": "The DeployedModel that had been deployed in the Endpoint.", "$ref": "GoogleCloudAiplatformV1beta1DeployedModel" } }, "description": "Response message for EndpointService.DeployModel.", "type": "object" }, "GenaiVertexV1beta1Error": { "id": "GenaiVertexV1beta1Error", "properties": { "code": { "type": "string", "description": "A URI that identifies the error type." }, "message": { "description": "A human-readable error message.", "type": "string" } }, "description": "Error message from an interaction.", "type": "object" }, "GoogleCloudAiplatformV1beta1FeatureOnlineStoreBigtableAutoScaling": { "properties": { "minNodeCount": { "type": "integer", "description": "Required. The minimum number of nodes to scale down to. Must be greater than or equal to 1.", "format": "int32" }, "maxNodeCount": { "format": "int32", "description": "Required. The maximum number of nodes to scale up to. Must be greater than or equal to min_node_count, and less than or equal to 10 times of 'min_node_count'.", "type": "integer" }, "cpuUtilizationTarget": { "description": "Optional. A percentage of the cluster's CPU capacity. Can be from 10% to 80%. When a cluster's CPU utilization exceeds the target that you have set, Bigtable immediately adds nodes to the cluster. When CPU utilization is substantially lower than the target, Bigtable removes nodes. If not set will default to 50%.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreBigtableAutoScaling", "type": "object" }, "GoogleCloudAiplatformV1beta1Probe": { "id": "GoogleCloudAiplatformV1beta1Probe", "description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.", "type": "object", "properties": { "exec": { "$ref": "GoogleCloudAiplatformV1beta1ProbeExecAction", "description": "ExecAction probes the health of a container by executing a command." }, "failureThreshold": { "type": "integer", "description": "Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.", "format": "int32" }, "timeoutSeconds": { "format": "int32", "type": "integer", "description": "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'." }, "tcpSocket": { "description": "TcpSocketAction probes the health of a container by opening a TCP socket connection.", "$ref": "GoogleCloudAiplatformV1beta1ProbeTcpSocketAction" }, "initialDelaySeconds": { "type": "integer", "format": "int32", "description": "Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'." }, "periodSeconds": { "description": "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'.", "type": "integer", "format": "int32" }, "grpc": { "$ref": "GoogleCloudAiplatformV1beta1ProbeGrpcAction", "description": "GrpcAction probes the health of a container by sending a gRPC request." }, "successThreshold": { "description": "Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'.", "type": "integer", "format": "int32" }, "httpGet": { "$ref": "GoogleCloudAiplatformV1beta1ProbeHttpGetAction", "description": "HttpGetAction probes the health of a container by sending an HTTP GET request." } } }, "GoogleCloudAiplatformV1beta1TrajectoryInOrderMatchInput": { "type": "object", "id": "GoogleCloudAiplatformV1beta1TrajectoryInOrderMatchInput", "properties": { "instances": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1TrajectoryInOrderMatchInstance" }, "description": "Required. Repeated TrajectoryInOrderMatch instance." }, "metricSpec": { "description": "Required. Spec for TrajectoryInOrderMatch metric.", "$ref": "GoogleCloudAiplatformV1beta1TrajectoryInOrderMatchSpec" } }, "description": "Instances and metric spec for TrajectoryInOrderMatch metric." }, "GoogleCloudAiplatformV1beta1PipelineTaskExecutorDetailContainerDetail": { "properties": { "mainJob": { "description": "Output only. The name of the CustomJob for the main container execution.", "type": "string", "readOnly": true }, "failedMainJobs": { "readOnly": true, "items": { "type": "string" }, "type": "array", "description": "Output only. The names of the previously failed CustomJob for the main container executions. The list includes the all attempts in chronological order." }, "failedPreCachingCheckJobs": { "items": { "type": "string" }, "type": "array", "readOnly": true, "description": "Output only. The names of the previously failed CustomJob for the pre-caching-check container executions. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events. The list includes the all attempts in chronological order." }, "preCachingCheckJob": { "readOnly": true, "description": "Output only. The name of the CustomJob for the pre-caching-check container execution. This job will be available if the PipelineJob.pipeline_spec specifies the `pre_caching_check` hook in the lifecycle events.", "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1PipelineTaskExecutorDetailContainerDetail", "description": "The detail of a container execution. It contains the job names of the lifecycle of a container execution." }, "GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigTtlConfig": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigTtlConfig", "properties": { "memoryRevisionDefaultTtl": { "format": "google-duration", "description": "Optional. The default TTL duration of the memory revisions in the Memory Bank. This applies to all operations that create a memory revision. If not set, a default TTL of 365 days will be used.", "type": "string" }, "granularTtlConfig": { "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigTtlConfigGranularTtlConfig", "description": "Optional. The granular TTL configuration of the memories in the Memory Bank." }, "defaultTtl": { "description": "Optional. The default TTL duration of the memories in the Memory Bank. This applies to all operations that create or update a memory.", "format": "google-duration", "type": "string" } }, "description": "Configuration for automatically setting the TTL (\"time-to-live\") of the memories in the Memory Bank." }, "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsGeneralTextGenerationEvaluationMetrics": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsGeneralTextGenerationEvaluationMetrics", "properties": { "bleu": { "type": "number", "format": "float", "description": "BLEU (bilingual evaluation understudy) scores based on sacrebleu implementation." }, "rougeLSum": { "type": "number", "format": "float", "description": "ROUGE-L (Longest Common Subsequence) scoring at summary level." } } }, "GoogleCloudAiplatformV1beta1ActiveLearningConfig": { "description": "Parameters that configure the active learning pipeline. Active learning will label the data incrementally by several iterations. For every iteration, it will select a batch of data based on the sampling strategy.", "id": "GoogleCloudAiplatformV1beta1ActiveLearningConfig", "type": "object", "properties": { "maxDataItemPercentage": { "type": "integer", "format": "int32", "description": "Max percent of total DataItems for human labeling." }, "sampleConfig": { "$ref": "GoogleCloudAiplatformV1beta1SampleConfig", "description": "Active learning data sampling config. For every active learning labeling iteration, it will select a batch of data based on the sampling strategy." }, "maxDataItemCount": { "type": "string", "format": "int64", "description": "Max number of human labeled DataItems." }, "trainingConfig": { "$ref": "GoogleCloudAiplatformV1beta1TrainingConfig", "description": "CMLE training config. For every active learning labeling iteration, system will train a machine learning model on CMLE. The trained model will be used by data sampling algorithm to select DataItems." } } }, "GenaiVertexV1beta1StepDelta": { "type": "object", "properties": { "delta": { "$ref": "GenaiVertexV1beta1StepDeltaData" }, "index": { "type": "integer", "format": "int32" } }, "id": "GenaiVertexV1beta1StepDelta" }, "GoogleCloudAiplatformV1beta1FailedRubric": { "id": "GoogleCloudAiplatformV1beta1FailedRubric", "type": "object", "properties": { "rubricId": { "type": "string", "description": "The unique ID of the rubric (if available from the metric source). Clients use this ID to query the corresponding rubric verdict." }, "classificationRationale": { "type": "string", "description": "The rationale provided by the Loss Analysis Classifier for why this failure maps to this specific Loss Cluster. e.g., \"The agent claimed an action without a tool call, matching 'Hallucination of Action'.\"" } }, "description": "Represents a specific failed rubric and the associated analysis." }, "GoogleCloudAiplatformV1beta1CreateServingProfileOperationMetadata": { "id": "GoogleCloudAiplatformV1beta1CreateServingProfileOperationMetadata", "description": "Runtime operation metadata for ServingProfileService.CreateServingProfile.", "type": "object", "properties": { "genericMetadata": { "readOnly": true, "description": "Output only. The standard operation metadata for Vertex AI.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } } }, "GoogleCloudAiplatformV1beta1UpsertDatapointsResponse": { "description": "Response message for IndexService.UpsertDatapoints", "id": "GoogleCloudAiplatformV1beta1UpsertDatapointsResponse", "properties": {}, "type": "object" }, "GoogleCloudAiplatformV1beta1ComputeTokensResponse": { "id": "GoogleCloudAiplatformV1beta1ComputeTokensResponse", "type": "object", "description": "Response message for ComputeTokens RPC call.", "properties": { "tokensInfo": { "items": { "$ref": "GoogleCloudAiplatformV1beta1TokensInfo" }, "description": "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.", "type": "array" } } }, "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics": { "type": "object", "properties": { "exactMatch": { "format": "float", "description": "The rate at which the input predicted strings exactly match their references.", "type": "number" } }, "id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics" }, "GoogleCloudAiplatformV1beta1SchemaPredictInstanceImageClassificationPredictionInstance": { "id": "GoogleCloudAiplatformV1beta1SchemaPredictInstanceImageClassificationPredictionInstance", "description": "Prediction input format for Image Classification.", "properties": { "content": { "description": "The image bytes or Cloud Storage URI to make the prediction on.", "type": "string" }, "mimeType": { "description": "The MIME type of the content of the image. Only the images in below listed MIME types are supported. - image/jpeg - image/gif - image/png - image/webp - image/bmp - image/tiff - image/vnd.microsoft.icon", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ListFeatureMonitorsResponse": { "properties": { "featureMonitors": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitor" }, "description": "The FeatureMonitors matching the request." }, "nextPageToken": { "type": "string", "description": "A token, which can be sent as ListFeatureMonitorsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages." } }, "id": "GoogleCloudAiplatformV1beta1ListFeatureMonitorsResponse", "description": "Response message for FeatureRegistryService.ListFeatureMonitors.", "type": "object" }, "GenaiVertexV1beta1McpServerToolResultDelta": { "properties": { "result": { "$ref": "GenaiVertexV1beta1Value" }, "name": { "type": "string" }, "serverName": { "type": "string" } }, "id": "GenaiVertexV1beta1McpServerToolResultDelta", "type": "object" }, "GoogleCloudAiplatformV1beta1Blob": { "type": "object", "description": "A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video.", "id": "GoogleCloudAiplatformV1beta1Blob", "properties": { "displayName": { "type": "string", "description": "Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled." }, "mimeType": { "type": "string", "description": "Required. The IANA standard MIME type of the source data." }, "data": { "format": "byte", "type": "string", "description": "Required. The raw bytes of the data." } } }, "GoogleCloudAiplatformV1beta1AuthConfig": { "description": "Auth configuration to run the extension.", "type": "object", "id": "GoogleCloudAiplatformV1beta1AuthConfig", "properties": { "oidcConfig": { "$ref": "GoogleCloudAiplatformV1beta1AuthConfigOidcConfig", "description": "Config for user OIDC auth." }, "httpBasicAuthConfig": { "$ref": "GoogleCloudAiplatformV1beta1AuthConfigHttpBasicAuthConfig", "description": "Config for HTTP Basic auth." }, "apiKeyConfig": { "description": "Config for API key auth.", "$ref": "GoogleCloudAiplatformV1beta1AuthConfigApiKeyConfig" }, "googleServiceAccountConfig": { "$ref": "GoogleCloudAiplatformV1beta1AuthConfigGoogleServiceAccountConfig", "description": "Config for Google Service Account auth." }, "authType": { "description": "Type of auth scheme.", "enumDescriptions": [ "", "No Auth.", "API Key Auth.", "HTTP Basic Auth.", "Google Service Account Auth.", "OAuth auth.", "OpenID Connect (OIDC) Auth." ], "type": "string", "enum": [ "AUTH_TYPE_UNSPECIFIED", "NO_AUTH", "API_KEY_AUTH", "HTTP_BASIC_AUTH", "GOOGLE_SERVICE_ACCOUNT_AUTH", "OAUTH", "OIDC_AUTH" ] }, "oauthConfig": { "description": "Config for user oauth.", "$ref": "GoogleCloudAiplatformV1beta1AuthConfigOauthConfig" } } }, "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsImageObjectDetectionEvaluationMetrics": { "description": "Metrics for image object detection evaluation results.", "id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsImageObjectDetectionEvaluationMetrics", "properties": { "boundingBoxMetrics": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsBoundingBoxMetrics" }, "description": "The bounding boxes match metrics for each intersection-over-union threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair." }, "boundingBoxMeanAveragePrecision": { "type": "number", "format": "float", "description": "The single metric for bounding boxes evaluation: the `meanAveragePrecision` averaged over all `boundingBoxMetricsEntries`." }, "evaluatedBoundingBoxCount": { "format": "int32", "type": "integer", "description": "The total number of bounding boxes (i.e. summed over all images) the ground truth used to create this evaluation had." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1FluencyInstance": { "type": "object", "id": "GoogleCloudAiplatformV1beta1FluencyInstance", "properties": { "prediction": { "type": "string", "description": "Required. Output of the evaluated model." } }, "description": "Spec for fluency instance." }, "GoogleCloudAiplatformV1beta1CreateModelMonitoringJobRequest": { "description": "Request message for ModelMonitoringService.CreateModelMonitoringJob.", "properties": { "parent": { "type": "string", "description": "Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMoniitors/{model_monitor}`" }, "modelMonitoringJobId": { "description": "Optional. The ID to use for the Model Monitoring Job, which will become the final component of the model monitoring job resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.", "type": "string" }, "modelMonitoringJob": { "description": "Required. The ModelMonitoringJob to create", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringJob" } }, "id": "GoogleCloudAiplatformV1beta1CreateModelMonitoringJobRequest", "type": "object" }, "GoogleCloudAiplatformV1beta1DoubleArray": { "id": "GoogleCloudAiplatformV1beta1DoubleArray", "type": "object", "properties": { "values": { "items": { "format": "double", "type": "number" }, "description": "A list of double values.", "type": "array" } }, "description": "A list of double values." }, "GoogleCloudAiplatformV1beta1NotebookSoftwareConfig": { "description": "Notebook Software Config. This is passed to the backend when user makes software configurations in UI.", "properties": { "colabImage": { "description": "Optional. Google-managed NotebookRuntime colab image.", "$ref": "GoogleCloudAiplatformV1beta1ColabImage" }, "env": { "description": "Optional. Environment variables to be passed to the container. Maximum limit is 100.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1EnvVar" } }, "postStartupScriptConfig": { "description": "Optional. Post startup script config.", "$ref": "GoogleCloudAiplatformV1beta1PostStartupScriptConfig" } }, "id": "GoogleCloudAiplatformV1beta1NotebookSoftwareConfig", "type": "object" }, "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponseFeatureDescriptor": { "description": "Metadata for requested Features.", "id": "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponseFeatureDescriptor", "type": "object", "properties": { "id": { "type": "string", "description": "Feature ID." } } }, "GoogleCloudAiplatformV1beta1ExportFeatureValuesRequest": { "description": "Request message for FeaturestoreService.ExportFeatureValues.", "id": "GoogleCloudAiplatformV1beta1ExportFeatureValuesRequest", "type": "object", "properties": { "destination": { "description": "Required. Specifies destination location and format.", "$ref": "GoogleCloudAiplatformV1beta1FeatureValueDestination" }, "settings": { "description": "Per-Feature export settings.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1DestinationFeatureSetting" } }, "snapshotExport": { "description": "Exports the latest Feature values of all entities of the EntityType within a time range.", "$ref": "GoogleCloudAiplatformV1beta1ExportFeatureValuesRequestSnapshotExport" }, "featureSelector": { "$ref": "GoogleCloudAiplatformV1beta1FeatureSelector", "description": "Required. Selects Features to export values of." }, "fullExport": { "description": "Exports all historical values of all entities of the EntityType within a time range", "$ref": "GoogleCloudAiplatformV1beta1ExportFeatureValuesRequestFullExport" } } }, "GenaiVertexV1beta1InteractionStreamingEvent": { "id": "GenaiVertexV1beta1InteractionStreamingEvent", "properties": { "interactionCompletedEvent": { "$ref": "GenaiVertexV1beta1InteractionCompletedSseEvent", "description": "The interaction data, used for interaction.completed events. Used when steps are enabled." }, "contentStop": { "deprecated": true, "$ref": "GenaiVertexV1beta1ContentStop", "description": "The content block stop data, used for content.stop events. Legacy content-based streaming event, used when steps are disabled." }, "stepStop": { "$ref": "GenaiVertexV1beta1StepStop", "description": "The step stop data, used for step.stop events. Step-based streaming event, used when steps are enabled." }, "contentDelta": { "description": "The content block delta data, used for content.delta events. Legacy content-based streaming event, used when steps are disabled.", "$ref": "GenaiVertexV1beta1ContentDelta", "deprecated": true }, "stepStart": { "description": "The step start data, used for step.start events. Step-based streaming event, used when steps are enabled.", "$ref": "GenaiVertexV1beta1StepStart" }, "stepDelta": { "description": "The step delta data, used for step.delta events. Step-based streaming event, used when steps are enabled.", "$ref": "GenaiVertexV1beta1StepDelta" }, "contentStart": { "deprecated": true, "description": "The content block start data, used for content.start events. Legacy content-based streaming event, used when steps are disabled.", "$ref": "GenaiVertexV1beta1ContentStart" }, "interactionStatusUpdate": { "description": "The interaction status data, used for interaction.status_update events.", "$ref": "GenaiVertexV1beta1InteractionStatusUpdate" }, "interactionStartEvent": { "$ref": "GenaiVertexV1beta1InteractionStartEvent", "deprecated": true, "description": "The interaction data, used for interaction.start events. Legacy event, used when steps are disabled." }, "errorEvent": { "description": "The error event data, used for error events.", "$ref": "GenaiVertexV1beta1ErrorEvent" }, "interactionCompleteEvent": { "deprecated": true, "$ref": "GenaiVertexV1beta1InteractionCompleteEvent", "description": "The interaction data, used for interaction.complete events. Legacy event, used when steps are disabled." }, "interactionCreatedEvent": { "$ref": "GenaiVertexV1beta1InteractionCreatedSseEvent", "description": "The interaction data, used for interaction.created events. Used when steps are enabled." }, "eventId": { "description": "The event_id token to be used to resume the interaction stream, from this event.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsVideoActionRecognitionMetrics": { "description": "Model evaluation metrics for video action recognition.", "properties": { "evaluatedActionCount": { "type": "integer", "description": "The number of ground truth actions used to create this evaluation.", "format": "int32" }, "videoActionMetrics": { "description": "The metric entries for precision window lengths: 1s,2s,3s.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsVideoActionMetrics" } } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsVideoActionRecognitionMetrics" }, "CloudAiLargeModelsVisionSemanticFilterResponse": { "properties": { "passedSemanticFilter": { "description": "This response is added when semantic filter config is turned on in EditConfig. It reports if this image is passed semantic filter response. If passed_semantic_filter is false, the bounding box information will be populated for user to check what caused the semantic filter to fail.", "type": "boolean" }, "namedBoundingBoxes": { "type": "array", "description": "Class labels of the bounding boxes that failed the semantic filtering. Bounding box coordinates.", "items": { "$ref": "CloudAiLargeModelsVisionNamedBoundingBox" } } }, "type": "object", "id": "CloudAiLargeModelsVisionSemanticFilterResponse" }, "GoogleCloudAiplatformV1beta1GenerateLossClustersOperationMetadata": { "type": "object", "description": "Operation metadata for EvaluationAnalyticsService.GenerateLossClusters.", "id": "GoogleCloudAiplatformV1beta1GenerateLossClustersOperationMetadata", "properties": { "genericMetadata": { "description": "Generic operation metadata.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } } }, "GoogleCloudAiplatformV1beta1KeepAliveProbeHttpGet": { "description": "Specifies the HTTP GET configuration for the probe.", "properties": { "path": { "type": "string", "description": "Required. Specifies the path of the HTTP GET request (e.g., `\"/is_busy\"`)." }, "port": { "type": "integer", "description": "Optional. Specifies the port number on the container to which the request is sent.", "format": "int32" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1KeepAliveProbeHttpGet" }, "GoogleCloudAiplatformV1beta1AuthConfigOidcConfig": { "id": "GoogleCloudAiplatformV1beta1AuthConfigOidcConfig", "description": "Config for user OIDC auth.", "properties": { "serviceAccount": { "type": "string", "description": "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)." }, "idToken": { "type": "string", "description": "OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ModelMonitoringAlertCondition": { "description": "Monitoring alert triggered condition.", "id": "GoogleCloudAiplatformV1beta1ModelMonitoringAlertCondition", "properties": { "threshold": { "type": "number", "format": "double", "description": "A condition that compares a stats value against a threshold. Alert will be triggered if value above the threshold." } }, "type": "object" }, "CloudAiLargeModelsVisionGenerateVideoExperimentsVideoTransform": { "properties": { "noiseStrength": { "type": "number", "description": "Optional. Noise strength for video transform.", "format": "float" }, "initializationVideo": { "$ref": "CloudAiLargeModelsVisionGenerateVideoRequestVideo", "description": "Optional. Input for video transform (sdedit, diffdiff). Note the input video from the main GenerateVideoRequest will be used as the conditioning." }, "mask": { "$ref": "CloudAiLargeModelsVisionGenerateVideoRequestVideo", "description": "Optional. Mask for video transform (diffdiff)." } }, "type": "object", "id": "CloudAiLargeModelsVisionGenerateVideoExperimentsVideoTransform" }, "GoogleCloudAiplatformV1beta1ResourcePoolAutoscalingSpec": { "type": "object", "properties": { "minReplicaCount": { "format": "int64", "type": "string", "description": "Optional. min replicas in the node pool, must be ≤ replica_count and \u003c max_replica_count or will throw error. For autoscaling enabled Ray-on-Vertex, we allow min_replica_count of a resource_pool to be 0 to match the OSS Ray behavior(https://docs.ray.io/en/latest/cluster/vms/user-guides/configuring-autoscaling.html#cluster-config-parameters). As for Persistent Resource, the min_replica_count must be \u003e 0, we added a corresponding validation inside CreatePersistentResourceRequestValidator.java." }, "maxReplicaCount": { "type": "string", "description": "Optional. max replicas in the node pool, must be ≥ replica_count and \u003e min_replica_count or will throw error", "format": "int64" } }, "description": "The min/max number of replicas allowed if enabling autoscaling", "id": "GoogleCloudAiplatformV1beta1ResourcePoolAutoscalingSpec" }, "GoogleCloudAiplatformV1beta1BleuSpec": { "description": "Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1.", "type": "object", "properties": { "useEffectiveOrder": { "description": "Optional. Whether to use_effective_order to compute bleu score.", "type": "boolean" } }, "id": "GoogleCloudAiplatformV1beta1BleuSpec" }, "GoogleCloudAiplatformV1beta1IndexEndpoint": { "type": "object", "description": "Indexes are deployed into it. An IndexEndpoint can have multiple DeployedIndexes.", "id": "GoogleCloudAiplatformV1beta1IndexEndpoint", "properties": { "name": { "type": "string", "description": "Output only. The resource name of the IndexEndpoint.", "readOnly": true }, "enablePrivateServiceConnect": { "type": "boolean", "deprecated": true, "description": "Optional. Deprecated: If true, expose the IndexEndpoint via private service connect. Only one of the fields, network or enable_private_service_connect, can be set." }, "updateTime": { "readOnly": true, "description": "Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of.", "format": "google-datetime", "type": "string" }, "network": { "description": "Optional. The full name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the IndexEndpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. network and private_service_connect_config are mutually exclusive. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in '12345', and {network} is network name.", "type": "string" }, "privateServiceConnectConfig": { "$ref": "GoogleCloudAiplatformV1beta1PrivateServiceConnectConfig", "description": "Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive." }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" }, "satisfiesPzi": { "type": "boolean", "description": "Output only. Reserved for future use.", "readOnly": true }, "displayName": { "type": "string", "description": "Required. The display name of the IndexEndpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters." }, "labels": { "description": "The labels with user-defined metadata to organize your IndexEndpoints. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.", "additionalProperties": { "type": "string" }, "type": "object" }, "etag": { "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "type": "string" }, "publicEndpointDomainName": { "description": "Output only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint.", "readOnly": true, "type": "string" }, "encryptionSpec": { "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec", "description": "Immutable. Customer-managed encryption key spec for an IndexEndpoint. If set, this IndexEndpoint and all sub-resources of this IndexEndpoint will be secured by this key." }, "createTime": { "format": "google-datetime", "description": "Output only. Timestamp when this IndexEndpoint was created.", "type": "string", "readOnly": true }, "publicEndpointEnabled": { "type": "boolean", "description": "Optional. If true, the deployed index will be accessible through public endpoint." }, "deployedIndexes": { "items": { "$ref": "GoogleCloudAiplatformV1beta1DeployedIndex" }, "description": "Output only. The indexes deployed in this endpoint.", "readOnly": true, "type": "array" }, "description": { "description": "The description of the IndexEndpoint.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1VertexMultimodalDatasetSource": { "id": "GoogleCloudAiplatformV1beta1VertexMultimodalDatasetSource", "properties": { "datasetName": { "description": "Required. The resource name of the Vertex Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", "type": "string" } }, "type": "object", "description": "The Vertex Multimodal Dataset for the input content." }, "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecPythonSpec": { "type": "object", "description": "Specification for running a Python application from source.", "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecPythonSpec", "properties": { "requirementsFile": { "type": "string", "description": "Optional. The path to the requirements file, relative to the source root. If not specified, defaults to \"requirements.txt\"." }, "version": { "description": "Optional. The version of Python to use. Supported versions include 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10.", "type": "string" }, "entrypointModule": { "description": "Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to \"agent\". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. This field should not be set if the source is `agent_config_source`.", "type": "string" }, "entrypointObject": { "type": "string", "description": "Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to \"root_agent\". This field should not be set if the source is `agent_config_source`." } } }, "GoogleCloudAiplatformV1beta1TrainingPipeline": { "description": "The TrainingPipeline orchestrates tasks associated with training a Model. It always executes the training task, and optionally may also export data from Vertex AI's Dataset which becomes the training input, upload the Model to Vertex AI, and evaluate the Model.", "properties": { "trainingTaskInputs": { "description": "Required. The training task's parameter(s), as specified in the training_task_definition's `inputs`.", "type": "any" }, "updateTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. Time when the TrainingPipeline was most recently updated." }, "name": { "readOnly": true, "type": "string", "description": "Output only. Resource name of the TrainingPipeline." }, "state": { "enum": [ "PIPELINE_STATE_UNSPECIFIED", "PIPELINE_STATE_QUEUED", "PIPELINE_STATE_PENDING", "PIPELINE_STATE_RUNNING", "PIPELINE_STATE_SUCCEEDED", "PIPELINE_STATE_FAILED", "PIPELINE_STATE_CANCELLING", "PIPELINE_STATE_CANCELLED", "PIPELINE_STATE_PAUSED" ], "type": "string", "enumDescriptions": [ "The pipeline state is unspecified.", "The pipeline has been created or resumed, and processing has not yet begun.", "The service is preparing to run the pipeline.", "The pipeline is in progress.", "The pipeline completed successfully.", "The pipeline failed.", "The pipeline is being cancelled. From this state, the pipeline may only go to either PIPELINE_STATE_SUCCEEDED, PIPELINE_STATE_FAILED or PIPELINE_STATE_CANCELLED.", "The pipeline has been cancelled.", "The pipeline has been stopped, and can be resumed." ], "readOnly": true, "description": "Output only. The detailed state of the pipeline." }, "modelId": { "type": "string", "description": "Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name. This value may be up to 63 characters, and valid characters are `[a-z0-9_-]`. The first character cannot be a number or hyphen." }, "parentModel": { "description": "Optional. When specify this field, the `model_to_upload` will not be uploaded as a new model, instead, it will become a new version of this `parent_model`.", "type": "string" }, "modelToUpload": { "description": "Describes the Model that may be uploaded (via ModelService.UploadModel) by this TrainingPipeline. The TrainingPipeline's training_task_definition should make clear whether this Model description should be populated, and if there are any special requirements regarding how it should be filled. If nothing is mentioned in the training_task_definition, then it should be assumed that this field should not be filled and the training task either uploads the Model without a need of this information, or that training task does not support uploading a Model as part of the pipeline. When the Pipeline's state becomes `PIPELINE_STATE_SUCCEEDED` and the trained Model had been uploaded into Vertex AI, then the model_to_upload's resource name is populated. The Model is always uploaded into the Project and Location in which this pipeline is.", "$ref": "GoogleCloudAiplatformV1beta1Model" }, "inputDataConfig": { "$ref": "GoogleCloudAiplatformV1beta1InputDataConfig", "description": "Specifies Vertex AI owned input data that may be used for training the Model. The TrainingPipeline's training_task_definition should make clear whether this config is used and if there are any special requirements on how it should be filled. If nothing about this config is mentioned in the training_task_definition, then it should be assumed that the TrainingPipeline does not depend on this configuration." }, "displayName": { "type": "string", "description": "Required. The user-defined name of this TrainingPipeline." }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The labels with user-defined metadata to organize TrainingPipelines. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels." }, "trainingTaskMetadata": { "type": "any", "readOnly": true, "description": "Output only. The metadata information as specified in the training_task_definition's `metadata`. This metadata is an auxiliary runtime and final information about the training task. While the pipeline is running this information is populated only at a best effort basis. Only present if the pipeline's training_task_definition contains `metadata` object." }, "endTime": { "format": "google-datetime", "description": "Output only. Time when the TrainingPipeline entered any of the following states: `PIPELINE_STATE_SUCCEEDED`, `PIPELINE_STATE_FAILED`, `PIPELINE_STATE_CANCELLED`.", "type": "string", "readOnly": true }, "createTime": { "description": "Output only. Time when the TrainingPipeline was created.", "format": "google-datetime", "type": "string", "readOnly": true }, "error": { "$ref": "GoogleRpcStatus", "readOnly": true, "description": "Output only. Only populated when the pipeline's state is `PIPELINE_STATE_FAILED` or `PIPELINE_STATE_CANCELLED`." }, "encryptionSpec": { "description": "Customer-managed encryption key spec for a TrainingPipeline. If set, this TrainingPipeline will be secured by this key. Note: Model trained by this TrainingPipeline is also secured by this key if model_to_upload is not set separately.", "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec" }, "trainingTaskDefinition": { "description": "Required. A Google Cloud Storage path to the YAML file that defines the training task which is responsible for producing the model artifact, and may also include additional auxiliary work. The definition files that can be used here are found in gs://google-cloud-aiplatform/schema/trainingjob/definition/. 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.", "type": "string" }, "startTime": { "description": "Output only. Time when the TrainingPipeline for the first time entered the `PIPELINE_STATE_RUNNING` state.", "format": "google-datetime", "readOnly": true, "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1TrainingPipeline", "type": "object" }, "GoogleCloudAiplatformV1beta1AugmentPromptRequestModel": { "type": "object", "id": "GoogleCloudAiplatformV1beta1AugmentPromptRequestModel", "properties": { "model": { "type": "string", "description": "Optional. The model that the user will send the augmented prompt for content generation." }, "modelVersion": { "type": "string", "description": "Optional. The model version of the backend deployed model." } }, "description": "Metadata of the backend deployed model." }, "GoogleCloudAiplatformV1beta1SearchModelDeploymentMonitoringStatsAnomaliesResponse": { "id": "GoogleCloudAiplatformV1beta1SearchModelDeploymentMonitoringStatsAnomaliesResponse", "type": "object", "properties": { "nextPageToken": { "description": "The page token that can be used by the next JobService.SearchModelDeploymentMonitoringStatsAnomalies call.", "type": "string" }, "monitoringStats": { "description": "Stats retrieved for requested objectives. There are at most 1000 ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.prediction_stats in the response.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringStatsAnomalies" } } }, "description": "Response message for JobService.SearchModelDeploymentMonitoringStatsAnomalies." }, "GoogleCloudAiplatformV1beta1ListFeatureMonitorJobsResponse": { "properties": { "featureMonitorJobs": { "description": "The FeatureMonitorJobs matching the request.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitorJob" } }, "nextPageToken": { "description": "A token, which can be sent as ListFeatureMonitorJobsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ListFeatureMonitorJobsResponse", "description": "Response message for FeatureRegistryService.ListFeatureMonitorJobs." }, "GoogleCloudAiplatformV1beta1ToolCallValidResults": { "type": "object", "properties": { "toolCallValidMetricValues": { "description": "Output only. Tool call valid metric values.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1ToolCallValidMetricValue" } } }, "id": "GoogleCloudAiplatformV1beta1ToolCallValidResults", "description": "Results for tool call valid metric." }, "GoogleCloudAiplatformV1beta1SummarizationHelpfulnessInput": { "type": "object", "properties": { "metricSpec": { "description": "Required. Spec for summarization helpfulness score metric.", "$ref": "GoogleCloudAiplatformV1beta1SummarizationHelpfulnessSpec" }, "instance": { "description": "Required. Summarization helpfulness instance.", "$ref": "GoogleCloudAiplatformV1beta1SummarizationHelpfulnessInstance" } }, "description": "Input for summarization helpfulness metric.", "id": "GoogleCloudAiplatformV1beta1SummarizationHelpfulnessInput" }, "GoogleCloudAiplatformV1beta1TrajectorySingleToolUseInput": { "id": "GoogleCloudAiplatformV1beta1TrajectorySingleToolUseInput", "type": "object", "properties": { "metricSpec": { "$ref": "GoogleCloudAiplatformV1beta1TrajectorySingleToolUseSpec", "description": "Required. Spec for TrajectorySingleToolUse metric." }, "instances": { "items": { "$ref": "GoogleCloudAiplatformV1beta1TrajectorySingleToolUseInstance" }, "type": "array", "description": "Required. Repeated TrajectorySingleToolUse instance." } }, "description": "Instances and metric spec for TrajectorySingleToolUse metric." }, "GoogleCloudAiplatformV1beta1ModelOriginalModelInfo": { "description": "Contains information about the original Model if this Model is a copy.", "type": "object", "properties": { "model": { "readOnly": true, "description": "Output only. The resource name of the Model this Model is a copy of, including the revision. Format: `projects/{project}/locations/{location}/models/{model_id}@{version_id}`", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1ModelOriginalModelInfo" }, "GoogleCloudAiplatformV1beta1Rubric": { "id": "GoogleCloudAiplatformV1beta1Rubric", "type": "object", "properties": { "type": { "description": "Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: \"SUMMARIZATION_QUALITY\", \"SAFETY_HARMFUL_CONTENT\", \"INSTRUCTION_ADHERENCE\".", "type": "string" }, "content": { "$ref": "GoogleCloudAiplatformV1beta1RubricContent", "description": "Required. The actual testable criteria for the rubric." }, "rubricId": { "description": "Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict.", "type": "string" }, "importance": { "type": "string", "enum": [ "IMPORTANCE_UNSPECIFIED", "HIGH", "MEDIUM", "LOW" ], "description": "Optional. The relative importance of this rubric.", "enumDescriptions": [ "Importance is not specified.", "High importance.", "Medium importance.", "Low importance." ] } }, "description": "Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics." }, "GoogleCloudAiplatformV1beta1SemanticGovernancePolicy": { "description": "Represents a governance policy applied to a specific Agent and optionally a specific Tool within that Agent.", "type": "object", "properties": { "etag": { "type": "string", "description": "Optional. Used to perform consistent read-modify-write transactions. If provided, the request will only succeed if the etag matches the current value. Otherwise, an ABORTED error will be returned." }, "mcpTools": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicyMcpTool" }, "description": "Optional. The McpTools that are affected by this policy." }, "updateTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. Timestamp when this SemanticGovernancePolicy was last updated." }, "naturalLanguageConstraint": { "description": "Required. The natural language constraint of the SemanticGovernancePolicy.", "type": "string" }, "name": { "description": "Identifier. Resource name of the SemanticGovernancePolicy.", "type": "string" }, "description": { "type": "string", "description": "Optional. The description of the SemanticGovernancePolicy." }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when this SemanticGovernancePolicy was created.", "readOnly": true }, "agentIdentity": { "readOnly": true, "type": "string", "description": "Output only. Represents the principal of the agent, used by the Policy Decision Point (PDP) for governance checks. For more information, see https://docs.cloud.google.com/agent-builder/agent-engine/agent-identity Format: `principal://TRUST_DOMAIN/NAMESPACE/AGENT_NAME` Example: `principal://agents.global.org-ORGANIZATION_ID.system.id.goog/resources/aiplatform/projects/PROJECT_NUMBER/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID`" }, "displayName": { "description": "Optional. The user-defined name of the SemanticGovernancePolicy.", "type": "string" }, "agent": { "description": "Required. The name of the agent in Agent Registry that is affected by this policy.", "type": "string" }, "agentResponseCustomization": { "description": "Optional. Settings for customizing the agent's response to end users when this policy is evaluated, such as messages displayed when the policy denies a request.", "$ref": "GoogleCloudAiplatformV1beta1AgentResponseCustomization" } }, "id": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicy" }, "GoogleCloudAiplatformV1beta1PredictResponse": { "type": "object", "description": "Response message for PredictionService.Predict.", "id": "GoogleCloudAiplatformV1beta1PredictResponse", "properties": { "predictions": { "type": "array", "description": "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.", "items": { "type": "any" } }, "metadata": { "description": "Output only. Request-level metadata returned by the model. The metadata type will be dependent upon the model implementation.", "type": "any", "readOnly": true }, "modelDisplayName": { "description": "Output only. The display name of the Model which is deployed as the DeployedModel that this prediction hits.", "readOnly": true, "type": "string" }, "modelVersionId": { "type": "string", "readOnly": true, "description": "Output only. The version ID of the Model which is deployed as the DeployedModel that this prediction hits." }, "model": { "type": "string", "readOnly": true, "description": "Output only. The resource name of the Model which is deployed as the DeployedModel that this prediction hits." }, "deployedModelId": { "description": "ID of the Endpoint's DeployedModel that served this prediction.", "type": "string" } } }, "GenaiVertexV1beta1ImageDelta": { "id": "GenaiVertexV1beta1ImageDelta", "properties": { "data": { "format": "byte", "type": "string" }, "resolution": { "enumDescriptions": [ "Default value. This value is unused.", "Low resolution.", "Medium resolution.", "High resolution.", "Ultra high resolution." ], "description": "The resolution of the media.", "type": "string", "enum": [ "MEDIA_RESOLUTION_UNSPECIFIED", "LOW", "MEDIUM", "HIGH", "ULTRA_HIGH" ] }, "mimeType": { "enumDescriptions": [ "", "PNG image format", "JPEG image format", "WebP image format", "HEIC image format", "HEIF image format", "GIF image format", "BMP image format", "TIFF image format" ], "enum": [ "TYPE_UNSPECIFIED", "TYPE_PNG", "TYPE_JPEG", "TYPE_WEBP", "TYPE_HEIC", "TYPE_HEIF", "TYPE_GIF", "TYPE_BMP", "TYPE_TIFF" ], "type": "string" }, "uri": { "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1AssessDataRequestBatchPredictionResourceUsageAssessmentConfig": { "type": "object", "properties": { "modelName": { "type": "string", "description": "Required. The name of the model used for batch prediction." } }, "id": "GoogleCloudAiplatformV1beta1AssessDataRequestBatchPredictionResourceUsageAssessmentConfig", "description": "Configuration for the batch prediction resource usage assessment." }, "GenaiVertexV1beta1UrlContextCallContent": { "description": "URL context content.", "properties": { "arguments": { "$ref": "GenaiVertexV1beta1UrlContextCallContentUrlContextCallArguments", "description": "Required. The arguments to pass to the URL context." } }, "deprecated": true, "type": "object", "id": "GenaiVertexV1beta1UrlContextCallContent" }, "GoogleCloudAiplatformV1beta1ImportIndexRequestConnectorConfigDatapointFieldMappingRestrict": { "properties": { "allowColumn": { "type": "array", "description": "Optional. The columns containing the allow values.", "items": { "type": "string" } }, "namespace": { "description": "Required. The namespace of the restrict in the index.", "type": "string" }, "denyColumn": { "items": { "type": "string" }, "type": "array", "description": "Optional. The columns containing the deny values." } }, "id": "GoogleCloudAiplatformV1beta1ImportIndexRequestConnectorConfigDatapointFieldMappingRestrict", "description": "Restrictions on string values.", "type": "object" }, "GoogleCloudAiplatformV1beta1ToolCallValidInput": { "properties": { "instances": { "items": { "$ref": "GoogleCloudAiplatformV1beta1ToolCallValidInstance" }, "description": "Required. Repeated tool call valid instances.", "type": "array" }, "metricSpec": { "description": "Required. Spec for tool call valid metric.", "$ref": "GoogleCloudAiplatformV1beta1ToolCallValidSpec" } }, "description": "Input for tool call valid metric.", "id": "GoogleCloudAiplatformV1beta1ToolCallValidInput", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaPromptSpecReferenceSentencePair": { "id": "GoogleCloudAiplatformV1beta1SchemaPromptSpecReferenceSentencePair", "description": "A pair of sentences used as reference in source and target languages.", "type": "object", "properties": { "sourceSentence": { "description": "Source sentence in the sentence pair.", "type": "string" }, "targetSentence": { "type": "string", "description": "Target sentence in the sentence pair." } } }, "GoogleCloudAiplatformV1beta1TrajectoryRecallInput": { "id": "GoogleCloudAiplatformV1beta1TrajectoryRecallInput", "description": "Instances and metric spec for TrajectoryRecall metric.", "type": "object", "properties": { "instances": { "items": { "$ref": "GoogleCloudAiplatformV1beta1TrajectoryRecallInstance" }, "description": "Required. Repeated TrajectoryRecall instance.", "type": "array" }, "metricSpec": { "description": "Required. Spec for TrajectoryRecall metric.", "$ref": "GoogleCloudAiplatformV1beta1TrajectoryRecallSpec" } } }, "GenaiVertexV1beta1SpeechConfig": { "type": "object", "id": "GenaiVertexV1beta1SpeechConfig", "properties": { "speaker": { "type": "string", "description": "The speaker's name, it should match the speaker name given in the prompt." }, "language": { "description": "The language of the speech.", "type": "string" }, "voice": { "type": "string", "description": "The voice of the speaker." } }, "description": "The configuration for speech interaction." }, "GoogleCloudAiplatformV1beta1EmbedContentRequest": { "type": "object", "properties": { "content": { "$ref": "GoogleCloudAiplatformV1beta1Content", "description": "Required. The content to be embedded." }, "taskType": { "enum": [ "UNSPECIFIED", "RETRIEVAL_QUERY", "RETRIEVAL_DOCUMENT", "SEMANTIC_SIMILARITY", "CLASSIFICATION", "CLUSTERING", "QUESTION_ANSWERING", "FACT_VERIFICATION", "CODE_RETRIEVAL_QUERY" ], "deprecated": true, "description": "Optional. Deprecated: Please use EmbedContentConfig.task_type instead. The task type of the embedding.", "type": "string", "enumDescriptions": [ "Unset value, which will default to one of the other enum values.", "Specifies the given text is a query in a search/retrieval setting.", "Specifies the given text is a document from the corpus being searched.", "Specifies the given text will be used for STS.", "Specifies that the given text will be classified.", "Specifies that the embeddings will be used for clustering.", "Specifies that the embeddings will be used for question answering.", "Specifies that the embeddings will be used for fact verification.", "Specifies that the embeddings will be used for code retrieval." ] }, "embedContentConfig": { "$ref": "GoogleCloudAiplatformV1beta1EmbedContentRequestEmbedContentConfig", "description": "Optional. Configuration for the EmbedContent request." }, "outputDimensionality": { "type": "integer", "description": "Optional. Deprecated: Please use EmbedContentConfig.output_dimensionality instead. Reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end.", "format": "int32", "deprecated": true }, "autoTruncate": { "type": "boolean", "description": "Optional. Deprecated: Please use EmbedContentConfig.auto_truncate instead. Whether to silently truncate the input content if it's longer than the maximum sequence length.", "deprecated": true }, "title": { "description": "Optional. Deprecated: Please use EmbedContentConfig.title instead. The title for the text.", "deprecated": true, "type": "string" } }, "description": "Request message for PredictionService.EmbedContent.", "id": "GoogleCloudAiplatformV1beta1EmbedContentRequest" }, "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigRankingRankService": { "id": "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigRankingRankService", "properties": { "modelName": { "description": "Optional. The model name of the rank service.", "type": "string" } }, "description": "Config for Rank Service.", "type": "object" }, "GoogleCloudAiplatformV1beta1DatasetVersion": { "properties": { "metadata": { "description": "Required. Output only. Additional information about the DatasetVersion.", "readOnly": true, "type": "any" }, "displayName": { "type": "string", "description": "The user-defined name of the DatasetVersion. The name can be up to 128 characters long and can consist of any UTF-8 characters." }, "createTime": { "format": "google-datetime", "description": "Output only. Timestamp when this DatasetVersion was created.", "type": "string", "readOnly": true }, "bigQueryDatasetName": { "description": "Output only. Name of the associated BigQuery dataset.", "type": "string", "readOnly": true }, "satisfiesPzi": { "readOnly": true, "description": "Output only. Reserved for future use.", "type": "boolean" }, "etag": { "type": "string", "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens." }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "type": "boolean", "readOnly": true }, "updateTime": { "description": "Output only. Timestamp when this DatasetVersion was last updated.", "readOnly": true, "format": "google-datetime", "type": "string" }, "modelReference": { "description": "Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.", "readOnly": true, "type": "string" }, "name": { "type": "string", "readOnly": true, "description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1DatasetVersion", "description": "Describes the dataset version." }, "GoogleCloudAiplatformV1beta1SchemaTextDataItem": { "type": "object", "description": "Payload of Text DataItem.", "id": "GoogleCloudAiplatformV1beta1SchemaTextDataItem", "properties": { "gcsUri": { "type": "string", "description": "Output only. Google Cloud Storage URI points to a copy of the original text in the Vertex-managed bucket in the user's project. The text file is up to 10MB in size.", "readOnly": true } } }, "GoogleCloudAiplatformV1beta1SchemaPredictParamsImageObjectDetectionPredictionParams": { "description": "Prediction model parameters for Image Object Detection.", "id": "GoogleCloudAiplatformV1beta1SchemaPredictParamsImageObjectDetectionPredictionParams", "properties": { "confidenceThreshold": { "description": "The Model only returns predictions with at least this confidence score. Default value is 0.0", "format": "float", "type": "number" }, "maxPredictions": { "description": "The Model only returns up to that many top, by confidence score, predictions per instance. Note that number of returned predictions is also limited by metadata's predictionsLimit. Default value is 10.", "format": "int32", "type": "integer" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1AugmentPromptRequest": { "properties": { "model": { "description": "Optional. Metadata of the backend deployed model.", "$ref": "GoogleCloudAiplatformV1beta1AugmentPromptRequestModel" }, "contents": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" }, "type": "array", "description": "Optional. Input content to augment, only text format is supported for now." }, "vertexRagStore": { "$ref": "GoogleCloudAiplatformV1beta1VertexRagStore", "description": "Optional. Retrieves contexts from the Vertex RagStore." } }, "id": "GoogleCloudAiplatformV1beta1AugmentPromptRequest", "type": "object", "description": "Request message for AugmentPrompt." }, "GenaiVertexV1beta1CodeExecutionCallContent": { "description": "Code execution content.", "deprecated": true, "type": "object", "id": "GenaiVertexV1beta1CodeExecutionCallContent", "properties": { "arguments": { "description": "Required. The arguments to pass to the code execution.", "$ref": "GenaiVertexV1beta1CodeExecutionCallContentCodeExecutionCallArguments" } } }, "GoogleCloudAiplatformV1beta1PairwiseMetricInstance": { "id": "GoogleCloudAiplatformV1beta1PairwiseMetricInstance", "description": "Pairwise metric instance. Usually one instance corresponds to one row in an evaluation dataset.", "type": "object", "properties": { "contentMapInstance": { "$ref": "GoogleCloudAiplatformV1beta1ContentMap", "description": "Key-value contents for the mutlimodality input, including text, image, video, audio, and pdf, etc. The key is placeholder in metric prompt template, and the value is the multimodal content." }, "jsonInstance": { "description": "Instance specified as a json string. String key-value pairs are expected in the json_instance to render PairwiseMetricSpec.instance_prompt_template.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageObjectDetection": { "description": "A TrainingJob that trains and uploads an AutoML Image Object Detection Model.", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageObjectDetection", "properties": { "inputs": { "description": "The input parameters of this TrainingJob.", "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionInputs" }, "metadata": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageObjectDetectionMetadata", "description": "The metadata information" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecDeveloperConnectConfig": { "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecDeveloperConnectConfig", "description": "Specifies the configuration for fetching source code from a Git repository that is managed by Developer Connect. This includes the repository, revision, and directory to use.", "type": "object", "properties": { "dir": { "description": "Required. Directory, relative to the source root, in which to run the build.", "type": "string" }, "gitRepositoryLink": { "type": "string", "description": "Required. The Developer Connect Git repository link, formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`." }, "revision": { "type": "string", "description": "Required. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref." } } }, "GoogleCloudAiplatformV1beta1CreateFeatureRequest": { "id": "GoogleCloudAiplatformV1beta1CreateFeatureRequest", "description": "Request message for FeaturestoreService.CreateFeature. Request message for FeatureRegistryService.CreateFeature.", "properties": { "feature": { "$ref": "GoogleCloudAiplatformV1beta1Feature", "description": "Required. The Feature to create." }, "parent": { "description": "Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", "type": "string" }, "featureId": { "description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ExplainResponse": { "properties": { "concurrentExplanations": { "description": "This field stores the results of the explanations run in parallel with The default explanation strategy/method.", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1ExplainResponseConcurrentExplanation" }, "type": "object" }, "explanations": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Explanation" }, "type": "array", "description": "The explanations of the Model's PredictResponse.predictions. It has the same number of elements as instances to be explained." }, "deployedModelId": { "type": "string", "description": "ID of the Endpoint's DeployedModel that served this explanation." }, "predictions": { "description": "The predictions that are the output of the predictions call. Same as PredictResponse.predictions.", "type": "array", "items": { "type": "any" } } }, "type": "object", "description": "Response message for PredictionService.Explain.", "id": "GoogleCloudAiplatformV1beta1ExplainResponse" }, "GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigInputArtifact": { "properties": { "artifactId": { "type": "string", "description": "Artifact resource id from MLMD. Which is the last portion of an artifact resource name: `projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}`. The artifact must stay within the same project, location and default metadatastore as the pipeline." } }, "id": "GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigInputArtifact", "description": "The type of an input artifact.", "type": "object" }, "GoogleCloudAiplatformV1beta1CloudLoggingConfigTracingContext": { "id": "GoogleCloudAiplatformV1beta1CloudLoggingConfigTracingContext", "type": "object", "properties": { "conversationId": { "type": "string", "description": "Optional. Unique identifier for a conversation (session thread), used to store and correlate messages within a conversation. The value corresponds to the `gen_ai.conversation.id` field in the the OpenTelemetry GenAI attributes." }, "traceId": { "type": "string", "description": "Optional. Trace ID being written to Cloud Trace in association with this log entry. e.g., `12345`, the numeric ID from the resource name. If a trace or span is being evaluated, this field should be populated." }, "spanId": { "description": "Optional. ID of the Cloud Trace span associated with the current operation in which the log is being written. e.g., `7a2190356c3fc94b`. If a span is being evaluated, this field should be populated.", "type": "string" } }, "description": "Tracing context for Observability correlation." }, "GoogleCloudAiplatformV1beta1DnsPeeringConfig": { "properties": { "domain": { "description": "Required. The DNS name suffix of the zone being peered to, e.g., \"my-internal-domain.corp.\". Must end with a dot.", "type": "string" }, "targetProject": { "description": "Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.", "type": "string" }, "targetNetwork": { "type": "string", "description": "Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible." } }, "type": "object", "description": "DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.", "id": "GoogleCloudAiplatformV1beta1DnsPeeringConfig" }, "GoogleCloudAiplatformV1beta1Scheduling": { "type": "object", "id": "GoogleCloudAiplatformV1beta1Scheduling", "properties": { "timeout": { "description": "Optional. The maximum job running time. The default is 7 days.", "type": "string", "format": "google-duration" }, "strategy": { "enumDescriptions": [ "Strategy will default to STANDARD.", "Deprecated. Regular on-demand provisioning strategy.", "Deprecated. Low cost by making potential use of spot resources.", "Standard provisioning strategy uses regular on-demand resources.", "Spot provisioning strategy uses spot resources.", "Flex Start strategy uses DWS to queue for resources." ], "enum": [ "STRATEGY_UNSPECIFIED", "ON_DEMAND", "LOW_COST", "STANDARD", "SPOT", "FLEX_START" ], "type": "string", "description": "Optional. This determines which type of scheduling strategy to use.", "enumDeprecated": [ false, true, true, false, false, false ] }, "restartJobOnWorkerRestart": { "description": "Optional. Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.", "type": "boolean" }, "disableRetries": { "description": "Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.", "type": "boolean" }, "maxWaitDuration": { "type": "string", "format": "google-duration", "description": "Optional. This is the maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to [Strategy.DWS_FLEX_START]. If set to 0, the job will wait indefinitely. The default is 24 hours." } }, "description": "All parameters related to queuing and scheduling of custom jobs." }, "GoogleCloudAiplatformV1beta1QuestionAnsweringCorrectnessResult": { "type": "object", "properties": { "explanation": { "readOnly": true, "description": "Output only. Explanation for question answering correctness score.", "type": "string" }, "confidence": { "type": "number", "format": "float", "readOnly": true, "description": "Output only. Confidence for question answering correctness score." }, "score": { "readOnly": true, "format": "float", "description": "Output only. Question Answering Correctness score.", "type": "number" } }, "description": "Spec for question answering correctness result.", "id": "GoogleCloudAiplatformV1beta1QuestionAnsweringCorrectnessResult" }, "GoogleCloudAiplatformV1beta1FileStatus": { "id": "GoogleCloudAiplatformV1beta1FileStatus", "description": "RagFile status.", "type": "object", "properties": { "state": { "type": "string", "description": "Output only. RagFile state.", "readOnly": true, "enumDescriptions": [ "RagFile state is unspecified.", "RagFile resource has been created and indexed successfully.", "RagFile resource is in a problematic state. See `error_message` field for details." ], "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "ERROR" ] }, "errorStatus": { "description": "Output only. Only when the `state` field is ERROR.", "readOnly": true, "type": "string" } } }, "GoogleCloudAiplatformV1beta1StructValue": { "properties": { "values": { "items": { "$ref": "GoogleCloudAiplatformV1beta1StructFieldValue" }, "description": "A list of field values.", "type": "array" } }, "id": "GoogleCloudAiplatformV1beta1StructValue", "type": "object", "description": "Struct (or object) type feature value." }, "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata": { "description": "All metadata of most recent monitoring pipelines.", "properties": { "status": { "$ref": "GoogleRpcStatus", "description": "The status of the most recent monitoring pipeline." }, "runTime": { "format": "google-datetime", "description": "The time that most recent monitoring pipelines that is related to this run.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionCustomJobMetadata": { "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionCustomJobMetadata", "type": "object", "properties": { "backingCustomJob": { "type": "string", "description": "The resource name of the CustomJob that has been created to carry out this custom task." } } }, "GoogleCloudAiplatformV1beta1ReinforcementTuningCodeExecutionRewardScorer": { "type": "object", "description": "ReinforcementTuningCodeExecutionRewardScorer allows users to implement a function to evaluate rewards for the sample response. The function signature is as follows: ``` def evaluate(example: dict[str, Any], response: dict[str, Any]) -\u003e float: ... ``` `example` is a ReinforcementTuningExample in ProtoJSON format, (i.e., the format is the same as as one line in the training/validation dataset except that the keys must be in camel case). System instructions (i.e., `example.get(\"systemInstruction\")`) and references (i.e., `example.get(\"references\")`) are also included in the `example` provided that they are set in the training/validation dataset. `response` is a Content in ProtoJSON format (i.e., keys must be in camel case), which is the same as the Online Prediction response for Gemini models. Note: Reward output by the `evaluate` function is clipped to be within `[-1, 1]`, i.e., `reward = max(min(reward, 1.0), -1.0)`.", "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningCodeExecutionRewardScorer", "properties": { "pythonCodeSnippet": { "type": "string", "description": "The python code snippet as a string for evaluating rewards. The following is an example python code snippet that returns a reward `1.0` for a parsed response matching the user-provided reference answer in per prompt references map. ``` def evaluate(example, response) -\u003e float: response_str = response.get(\"parts\", [])0 references = example.get(\"references\", {}) if response_str == references.get(\"concise_answer\"): return 1.0 return -1.0 ``` Note: Reward output by the evaluate function is clipped to be within `[-1, 1]`, i.e., `reward = max(min(reward, 1.0), -1.0)`." } } }, "GoogleCloudAiplatformV1beta1StudySpecParameterSpec": { "id": "GoogleCloudAiplatformV1beta1StudySpecParameterSpec", "type": "object", "properties": { "doubleValueSpec": { "$ref": "GoogleCloudAiplatformV1beta1StudySpecParameterSpecDoubleValueSpec", "description": "The value spec for a 'DOUBLE' parameter." }, "conditionalParameterSpecs": { "description": "A conditional parameter node is active if the parameter's value matches the conditional node's parent_value_condition. If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1StudySpecParameterSpecConditionalParameterSpec" } }, "parameterId": { "description": "Required. The ID of the parameter. Must not contain whitespaces and must be unique amongst all ParameterSpecs.", "type": "string" }, "integerValueSpec": { "description": "The value spec for an 'INTEGER' parameter.", "$ref": "GoogleCloudAiplatformV1beta1StudySpecParameterSpecIntegerValueSpec" }, "discreteValueSpec": { "description": "The value spec for a 'DISCRETE' parameter.", "$ref": "GoogleCloudAiplatformV1beta1StudySpecParameterSpecDiscreteValueSpec" }, "categoricalValueSpec": { "$ref": "GoogleCloudAiplatformV1beta1StudySpecParameterSpecCategoricalValueSpec", "description": "The value spec for a 'CATEGORICAL' parameter." }, "scaleType": { "description": "How the parameter should be scaled. Leave unset for `CATEGORICAL` parameters.", "type": "string", "enumDescriptions": [ "By default, no scaling is applied.", "Scales the feasible space to (0, 1) linearly.", "Scales the feasible space logarithmically to (0, 1). The entire feasible space must be strictly positive.", "Scales the feasible space \"reverse\" logarithmically to (0, 1). The result is that values close to the top of the feasible space are spread out more than points near the bottom. The entire feasible space must be strictly positive." ], "enum": [ "SCALE_TYPE_UNSPECIFIED", "UNIT_LINEAR_SCALE", "UNIT_LOG_SCALE", "UNIT_REVERSE_LOG_SCALE" ] } }, "description": "Represents a single parameter to optimize." }, "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigMemoryTopicManagedMemoryTopic": { "properties": { "managedTopicEnum": { "description": "Required. Represents the managed topic.", "enumDescriptions": [ "Represents an unspecified topic. This value should not be used.", "Represents significant personal information about the User like first names, relationships, hobbies, important dates.", "Represents stated or implied likes, dislikes, preferred styles, or patterns.", "Represents important milestones or conclusions within the dialogue.", "Represents information that the user explicitly requested to remember or forget." ], "type": "string", "enum": [ "MANAGED_TOPIC_ENUM_UNSPECIFIED", "USER_PERSONAL_INFO", "USER_PREFERENCES", "KEY_CONVERSATION_DETAILS", "EXPLICIT_INSTRUCTIONS" ] } }, "id": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigMemoryTopicManagedMemoryTopic", "description": "A managed memory topic defined by the system.", "type": "object" }, "GoogleCloudAiplatformV1beta1DeleteMetadataStoreOperationMetadata": { "id": "GoogleCloudAiplatformV1beta1DeleteMetadataStoreOperationMetadata", "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "Operation metadata for deleting a MetadataStore." } }, "description": "Details of operations that perform MetadataService.DeleteMetadataStore.", "type": "object" }, "GenaiVertexV1beta1CodeExecution": { "properties": {}, "description": "A tool that can be used by the model to execute code.", "id": "GenaiVertexV1beta1CodeExecution", "type": "object" }, "GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualityInstance": { "properties": { "prediction": { "type": "string", "description": "Required. Output of the candidate model." }, "baselinePrediction": { "description": "Required. Output of the baseline model.", "type": "string" }, "context": { "description": "Required. Text to answer the question.", "type": "string" }, "instruction": { "description": "Required. Question Answering prompt for LLM.", "type": "string" }, "reference": { "description": "Optional. Ground truth used to compare against the prediction.", "type": "string" } }, "type": "object", "description": "Spec for pairwise question answering quality instance.", "id": "GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualityInstance" }, "GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerJsonMatchExpression": { "type": "object", "properties": { "valueStringMatchExpression": { "description": "String match expression to match against the extracted value from the JSON representation of the parsed response.", "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerStringMatchExpression" }, "keyName": { "type": "string", "description": "The key name to find the value in the parsed response that's in JSON format. Only first-level key matching is supported." } }, "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerJsonMatchExpression", "description": "JsonMatchExpression supports converting the parsed responses to JSON format, finding the value in the JSON response that matches the key_name in the first level, and performing StringMatchExpression operation on the matched JSON value." }, "GoogleCloudAiplatformV1beta1UsageMetadata": { "properties": { "promptTokenCount": { "format": "int32", "type": "integer", "description": "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." }, "thoughtsTokenCount": { "type": "integer", "description": "Output only. The number of tokens that were part of the model's generated \"thoughts\" output, if applicable.", "readOnly": true, "format": "int32" }, "toolUsePromptTokenCount": { "type": "integer", "readOnly": true, "description": "Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.", "format": "int32" }, "cacheTokensDetails": { "type": "array", "description": "Output only. A detailed breakdown of the token count for each modality in the cached content.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" }, "readOnly": true }, "candidatesTokensDetails": { "type": "array", "readOnly": true, "items": { "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" }, "description": "Output only. A detailed breakdown of the token count for each modality in the generated candidates." }, "trafficType": { "enumDescriptions": [ "Unspecified request traffic type.", "Type for Pay-As-You-Go traffic.", "Type for Priority Pay-As-You-Go traffic.", "Type for Flex traffic.", "Type for Off-Peak Pay-As-You-Go traffic.", "Type for Provisioned Throughput traffic." ], "enum": [ "TRAFFIC_TYPE_UNSPECIFIED", "ON_DEMAND", "ON_DEMAND_PRIORITY", "ON_DEMAND_FLEX", "ON_DEMAND_OFFPEAK", "PROVISIONED_THROUGHPUT" ], "readOnly": true, "description": "Output only. The traffic type for this request.", "type": "string" }, "cachedContentTokenCount": { "format": "int32", "readOnly": true, "type": "integer", "description": "Output only. The number of tokens in the cached content that was used for this request." }, "candidatesTokenCount": { "type": "integer", "format": "int32", "description": "The total number of tokens in the generated candidates." }, "toolUsePromptTokensDetails": { "description": "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.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" } }, "totalTokenCount": { "description": "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`.", "format": "int32", "type": "integer" }, "promptTokensDetails": { "items": { "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" }, "description": "Output only. A detailed breakdown of the token count for each modality in the prompt.", "type": "array", "readOnly": true } }, "description": "Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics.", "id": "GoogleCloudAiplatformV1beta1UsageMetadata", "type": "object" }, "GoogleCloudAiplatformV1beta1A2ATaskRecordStatus": { "type": "object", "id": "GoogleCloudAiplatformV1beta1A2ATaskRecordStatus", "properties": { "message": { "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordMessage", "description": "Output only. The status message associated with the state." }, "state": { "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "TASK_STATE_SUBMITTED", "TASK_STATE_WORKING", "TASK_STATE_COMPLETED", "TASK_STATE_FAILED", "TASK_STATE_CANCELED", "TASK_STATE_INPUT_REQUIRED", "TASK_STATE_REJECTED", "TASK_STATE_AUTH_REQUIRED" ], "description": "Output only. The current state of the task.", "enumDescriptions": [ "The task is in an unknown or indeterminate state.", "Indicates that a task has been successfully submitted and acknowledged.", "Indicates that a task is actively being processed by the agent.", "Indicates that a task has finished successfully. This is a terminal state.", "Indicates that a task has finished with an error. This is a terminal state.", "Indicates that a task was canceled before completion. This is a terminal state.", "Indicates that the agent requires additional user input to proceed. This is an interrupted state.", "Indicates that the agent has decided to not perform the task. This may be done during initial task creation or later once an agent has determined it can't or won't proceed. This is a terminal state.", "Indicates that authentication is required to proceed. This is an interrupted state." ], "type": "string" }, "timestamp": { "format": "google-datetime", "type": "string", "description": "Output only. The time at which the state was set.", "readOnly": true } }, "description": "Represents the status of an A2ATaskRecord." }, "GoogleCloudAiplatformV1beta1CountTokensRequest": { "type": "object", "description": "Request message for PredictionService.CountTokens.", "id": "GoogleCloudAiplatformV1beta1CountTokensRequest", "properties": { "generationConfig": { "$ref": "GoogleCloudAiplatformV1beta1GenerationConfig", "description": "Optional. Generation config that the model will use to generate the response." }, "model": { "description": "Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", "type": "string" }, "contents": { "description": "Optional. Input content.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" }, "type": "array" }, "tools": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Tool" }, "description": "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." }, "systemInstruction": { "description": "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.", "$ref": "GoogleCloudAiplatformV1beta1Content" }, "instances": { "description": "Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", "items": { "type": "any" }, "type": "array" } } }, "GoogleCloudAiplatformV1beta1A2APart": { "type": "object", "id": "GoogleCloudAiplatformV1beta1A2APart", "properties": { "url": { "type": "string", "description": "Optional. A URL pointing to the content." }, "data": { "type": "any", "description": "Optional. Arbitrary data content." }, "text": { "type": "string", "description": "Optional. Textual content." }, "filename": { "type": "string", "description": "Optional. The name of the file, when the part represents a file." }, "raw": { "description": "Optional. Raw binary content.", "type": "string", "format": "byte" }, "mediaType": { "description": "Optional. The IANA media type of the content, e.g. \"text/plain\" or \"image/png\".", "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases." } }, "description": "A single part of a message or artifact. A part carries exactly one kind of content." }, "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponseEntityView": { "properties": { "entityId": { "description": "ID of the requested entity.", "type": "string" }, "data": { "description": "Each piece of data holds the k requested values for one requested Feature. If no values for the requested Feature exist, the corresponding cell will be empty. This has the same size and is in the same order as the features from the header ReadFeatureValuesResponse.header.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponseEntityViewData" }, "type": "array" } }, "description": "Entity view with Feature values.", "type": "object", "id": "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponseEntityView" }, "GoogleCloudAiplatformV1beta1CompactionConfig": { "type": "object", "description": "Configuration for session compaction. Compaction has two independent categories that may be enabled individually or together. When both are enabled they run as a stackable pipeline (deterministic event editing first, then summarization if the session is still above the target). At least one category must be enabled; a config with neither is rejected (enforced server-side). This message is standalone so it can be reused across surfaces (e.g. on the compact request today, and on session creation for a future reactive trigger).", "properties": { "eventEditing": { "description": "Optional. Event-history editing compaction configuration. Set to enable deterministic event editing (e.g. masking oversized tool responses). Can be combined with `summarization`.", "$ref": "GoogleCloudAiplatformV1beta1CompactionConfigEventEditingConfig" }, "summarization": { "$ref": "GoogleCloudAiplatformV1beta1CompactionConfigLlmSummarizationConfig", "description": "Optional. LLM summarization compaction configuration. Set to enable summarization-based compaction. Can be combined with `event_editing`." } }, "id": "GoogleCloudAiplatformV1beta1CompactionConfig" }, "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestGcsSource": { "type": "object", "properties": { "gcsUri": { "description": "Required. The Cloud Storage location of the input data.", "type": "string" }, "importSchemaConfig": { "description": "Required. Schema configuration for the input data.", "$ref": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestImportSchemaConfig" } }, "description": "Source for loading data from Cloud Storage.", "id": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestGcsSource" }, "GoogleCloudAiplatformV1beta1ReadIndexDatapointsResponse": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ReadIndexDatapointsResponse", "properties": { "datapoints": { "description": "The result list of datapoints.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1IndexDatapoint" } } }, "description": "The response message for MatchService.ReadIndexDatapoints." }, "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigFilter": { "properties": { "vectorDistanceThreshold": { "description": "Optional. Only returns contexts with vector distance smaller than the threshold.", "type": "number", "format": "double" }, "vectorSimilarityThreshold": { "type": "number", "description": "Optional. Only returns contexts with vector similarity larger than the threshold.", "format": "double" }, "metadataFilter": { "description": "Optional. String for metadata filtering.", "type": "string" } }, "type": "object", "id": "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigFilter", "description": "Config for filters." }, "GoogleCloudAiplatformV1beta1A2aTaskEvent": { "id": "GoogleCloudAiplatformV1beta1A2aTaskEvent", "description": "An event that records a single change applied to a task's state.", "properties": { "generation": { "format": "int64", "description": "Output only. The generation number of the task after this event is applied.", "readOnly": true, "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional. Additional context or parameters related to the event. Extensions can be used to strongly type metadata values for specific use cases." }, "eventData": { "$ref": "GoogleCloudAiplatformV1beta1A2aTaskEventData", "description": "Required. The data describing the change carried by this event." }, "createTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The time at which the event was created." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1Memory": { "description": "A memory.", "type": "object", "id": "GoogleCloudAiplatformV1beta1Memory", "properties": { "createTime": { "description": "Output only. Represents the timestamp when this Memory was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "ttl": { "format": "google-duration", "type": "string", "description": "Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL." }, "revisionTtl": { "description": "Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.", "type": "string", "format": "google-duration" }, "description": { "description": "Optional. Represents the description of the Memory.", "type": "string" }, "displayName": { "description": "Optional. Represents the display name of the Memory.", "type": "string" }, "context": { "description": "Optional. Represents the context of the memory.", "type": "string" }, "fact": { "description": "Optional. Represents semantic knowledge extracted from the source content.", "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1MemoryMetadataValue" }, "description": "Optional. Represents user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank." }, "revisionLabels": { "description": "Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.", "type": "object", "additionalProperties": { "type": "string" } }, "topics": { "items": { "$ref": "GoogleCloudAiplatformV1beta1MemoryTopicId" }, "type": "array", "description": "Optional. Represents the Topics of the Memory." }, "expireTime": { "description": "Optional. Represents the timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided.", "type": "string", "format": "google-datetime" }, "name": { "description": "Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "type": "string" }, "structuredContent": { "$ref": "GoogleCloudAiplatformV1beta1MemoryStructuredContent", "description": "Optional. Represents the structured content of the memory." }, "scope": { "type": "object", "description": "Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.", "additionalProperties": { "type": "string" } }, "updateTime": { "description": "Output only. Represents the timestamp when this Memory was most recently updated.", "format": "google-datetime", "type": "string", "readOnly": true }, "revisionExpireTime": { "description": "Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.", "type": "string", "format": "google-datetime" }, "memoryType": { "enumDescriptions": [ "Represents an unspecified memory type. This value should not be used.", "Indicates belonging to a collection of natural language memories.", "Indicates belonging to a structured profile." ], "enum": [ "MEMORY_TYPE_UNSPECIFIED", "NATURAL_LANGUAGE_COLLECTION", "STRUCTURED_PROFILE" ], "type": "string", "description": "Optional. Represents the type of the memory. If not set, the `NATURAL_LANGUAGE_COLLECTION` type is used. If `STRUCTURED_COLLECTION` or `STRUCTURED_PROFILE` is used, then `structured_data` must be provided." }, "disableMemoryRevisions": { "description": "Optional. Input only. Indicates whether no revision will be created for this request.", "type": "boolean" } } }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputs": { "type": "object", "properties": { "exportEvaluatedDataItemsConfig": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig", "description": "Configuration for exporting test set predictions to a BigQuery table. If this configuration is absent, then the export is not performed." }, "transformations": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation" }, "description": "Each transformation will apply transform function to given input column. And the result will be used for training. When creating transformation for BigQuery Struct column, the column should be flattened using \".\" as the delimiter." }, "optimizationObjectiveRecallValue": { "type": "number", "format": "float", "description": "Required when optimization_objective is \"maximize-precision-at-recall\". Must be between 0 and 1, inclusive." }, "weightColumnName": { "description": "Column name that should be used as the weight column. Higher values in this column give more importance to the row during model training. The column must have numeric values between 0 and 10000 inclusively; 0 means the row is ignored for training. If weight column field is not set, then all rows are assumed to have equal weight of 1.", "type": "string" }, "optimizationObjective": { "description": "Objective function the model is optimizing towards. The training process creates a model that maximizes/minimizes the value of the objective function over the validation set. The supported optimization objectives depend on the prediction type. If the field is not set, a default objective function is used. classification (binary): \"maximize-au-roc\" (default) - Maximize the area under the receiver operating characteristic (ROC) curve. \"minimize-log-loss\" - Minimize log loss. \"maximize-au-prc\" - Maximize the area under the precision-recall curve. \"maximize-precision-at-recall\" - Maximize precision for a specified recall value. \"maximize-recall-at-precision\" - Maximize recall for a specified precision value. classification (multi-class): \"minimize-log-loss\" (default) - Minimize log loss. regression: \"minimize-rmse\" (default) - Minimize root-mean-squared error (RMSE). \"minimize-mae\" - Minimize mean-absolute error (MAE). \"minimize-rmsle\" - Minimize root-mean-squared log error (RMSLE).", "type": "string" }, "additionalExperiments": { "description": "Additional experiment flags for the Tables training pipeline.", "type": "array", "items": { "type": "string" } }, "predictionType": { "type": "string", "description": "The type of prediction the Model is to produce. \"classification\" - Predict one out of multiple target values is picked for each row. \"regression\" - Predict a value based on its relation to other values. This type is available only to columns that contain semantically numeric values, i.e. integers or floating point number, even if stored as e.g. strings." }, "targetColumn": { "description": "The column name of the target column that the model is to predict.", "type": "string" }, "disableEarlyStopping": { "description": "Use the entire training budget. This disables the early stopping feature. By default, the early stopping feature is enabled, which means that AutoML Tables might stop training before the entire training budget has been used.", "type": "boolean" }, "trainBudgetMilliNodeHours": { "description": "Required. The train budget of creating this model, expressed in milli node hours i.e. 1,000 value in this field means 1 node hour. The training cost of the model will not exceed this budget. The final cost will be attempted to be close to the budget, though may end up being (even) noticeably smaller - at the backend's discretion. This especially may happen when further model training ceases to provide any improvements. If the budget is set to a value known to be insufficient to train a model for the given dataset, the training won't be attempted and will error. The train budget must be between 1,000 and 72,000 milli node hours, inclusive.", "format": "int64", "type": "string" }, "optimizationObjectivePrecisionValue": { "description": "Required when optimization_objective is \"maximize-recall-at-precision\". Must be between 0 and 1, inclusive.", "format": "float", "type": "number" } }, "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputs" }, "GoogleCloudAiplatformV1beta1Extension": { "description": "Extensions are tools for large language models to access external data, run computations, etc.", "type": "object", "id": "GoogleCloudAiplatformV1beta1Extension", "properties": { "privateServiceConnectConfig": { "description": "Optional. The PrivateServiceConnect config for the extension. If specified, the service endpoints associated with the Extension should be [registered with private network access in the provided Service Directory](https://cloud.google.com/service-directory/docs/configuring-private-network-access). If the service contains more than one endpoint with a network, the service will arbitrarilty choose one of the endpoints to use for extension execution.", "$ref": "GoogleCloudAiplatformV1beta1ExtensionPrivateServiceConnectConfig" }, "updateTime": { "description": "Output only. Timestamp when this Extension was most recently updated.", "type": "string", "format": "google-datetime", "readOnly": true }, "satisfiesPzs": { "type": "boolean", "readOnly": true, "description": "Output only. Reserved for future use." }, "toolUseExamples": { "items": { "$ref": "GoogleCloudAiplatformV1beta1ToolUseExample" }, "description": "Optional. Examples to illustrate the usage of the extension as a tool.", "type": "array" }, "name": { "type": "string", "description": "Identifier. The resource name of the Extension." }, "satisfiesPzi": { "readOnly": true, "description": "Output only. Reserved for future use.", "type": "boolean" }, "extensionOperations": { "type": "array", "readOnly": true, "items": { "$ref": "GoogleCloudAiplatformV1beta1ExtensionOperation" }, "description": "Output only. Supported operations." }, "description": { "description": "Optional. The description of the Extension.", "type": "string" }, "etag": { "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "type": "string" }, "displayName": { "type": "string", "description": "Required. The display name of the Extension. The name can be up to 128 characters long and can consist of any UTF-8 characters." }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when this Extension was created." }, "manifest": { "$ref": "GoogleCloudAiplatformV1beta1ExtensionManifest", "description": "Required. Manifest of the Extension." }, "runtimeConfig": { "description": "Optional. Runtime config controlling the runtime behavior of this Extension.", "$ref": "GoogleCloudAiplatformV1beta1RuntimeConfig" } } }, "GenaiVertexV1beta1TextDelta": { "properties": { "text": { "type": "string" } }, "id": "GenaiVertexV1beta1TextDelta", "type": "object" }, "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig": { "description": "The config for Prediction data drift detection.", "id": "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveConfigPredictionDriftDetectionConfig", "type": "object", "properties": { "defaultDriftThreshold": { "description": "Drift anomaly detection threshold used by all features. When the per-feature thresholds are not set, this field can be used to specify a threshold for all features.", "$ref": "GoogleCloudAiplatformV1beta1ThresholdConfig" }, "driftThresholds": { "description": "Key is the feature name and value is the threshold. If a feature needs to be monitored for drift, a value threshold must be configured for that feature. The threshold here is against feature distribution distance between different time windws.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1ThresholdConfig" } }, "attributionScoreDriftThresholds": { "description": "Key is the feature name and value is the threshold. The threshold here is against attribution score distance between different time windows.", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1ThresholdConfig" }, "type": "object" } } }, "GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences": { "type": "object", "description": "The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc..", "properties": { "references": { "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelResourceReference" }, "description": "Required.", "type": "object" }, "colabNotebookDisabled": { "type": "boolean", "description": "Optional. For notebook resource. When set to true, the Colab Enterprise link will be disabled in the \"open notebook\" dialog in UI." }, "resourceDescription": { "type": "string", "description": "Optional. Description of the resource." }, "resourceUseCase": { "description": "Optional. Use case (CUJ) of the resource.", "type": "string" }, "resourceTitle": { "type": "string", "description": "Optional. Title of the resource." }, "title": { "description": "Required. ", "type": "string" }, "supportsWorkbench": { "description": "Optional. For notebook resource, whether the notebook supports Workbench.", "type": "boolean" } }, "id": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences" }, "GoogleCloudAiplatformV1beta1StudySpecParameterSpecConditionalParameterSpec": { "type": "object", "description": "Represents a parameter spec with condition from its parent parameter.", "id": "GoogleCloudAiplatformV1beta1StudySpecParameterSpecConditionalParameterSpec", "properties": { "parentCategoricalValues": { "$ref": "GoogleCloudAiplatformV1beta1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition", "description": "The spec for matching values from a parent parameter of `CATEGORICAL` type." }, "parentIntValues": { "$ref": "GoogleCloudAiplatformV1beta1StudySpecParameterSpecConditionalParameterSpecIntValueCondition", "description": "The spec for matching values from a parent parameter of `INTEGER` type." }, "parameterSpec": { "description": "Required. The spec for a conditional parameter.", "$ref": "GoogleCloudAiplatformV1beta1StudySpecParameterSpec" }, "parentDiscreteValues": { "$ref": "GoogleCloudAiplatformV1beta1StudySpecParameterSpecConditionalParameterSpecDiscreteValueCondition", "description": "The spec for matching values from a parent parameter of `DISCRETE` type." } } }, "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet": { "description": "A review snippet that is used to generate the answer.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet", "properties": { "title": { "type": "string", "description": "The title of the review." }, "googleMapsUri": { "description": "A link to show the review on Google Maps.", "type": "string" }, "reviewId": { "description": "The ID of the review that is being referenced.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringScheduleConfig": { "description": "The config for scheduling monitoring job.", "id": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringScheduleConfig", "properties": { "monitorInterval": { "type": "string", "format": "google-duration", "description": "Required. The model monitoring job scheduling interval. It will be rounded up to next full hour. This defines how often the monitoring jobs are triggered." }, "monitorWindow": { "description": "The time window of the prediction data being included in each prediction dataset. This window specifies how long the data should be collected from historical model results for each run. If not set, ModelDeploymentMonitoringScheduleConfig.monitor_interval will be used. e.g. If currently the cutoff time is 2022-01-08 14:30:00 and the monitor_window is set to be 3600, then data from 2022-01-08 13:30:00 to 2022-01-08 14:30:00 will be retrieved and aggregated to calculate the monitoring statistics.", "format": "google-duration", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ListFeaturesResponse": { "properties": { "features": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Feature" }, "type": "array", "description": "The Features matching the request." }, "nextPageToken": { "description": "A token, which can be sent as ListFeaturesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1ListFeaturesResponse", "description": "Response message for FeaturestoreService.ListFeatures. Response message for FeatureRegistryService.ListFeatures.", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsImageSegmentationEvaluationMetrics": { "id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsImageSegmentationEvaluationMetrics", "type": "object", "properties": { "confidenceMetricsEntries": { "type": "array", "description": "Metrics for each confidenceThreshold in 0.00,0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 Precision-recall curve can be derived from it.", "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsImageSegmentationEvaluationMetricsConfidenceMetricsEntry" } } }, "description": "Metrics for image segmentation evaluation results." }, "GenaiVertexV1beta1TranscriptionConfig": { "description": "Configuration for speech recognition (transcription).", "type": "object", "id": "GenaiVertexV1beta1TranscriptionConfig", "properties": { "languageCodes": { "items": { "type": "string" }, "type": "array", "description": "Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to automatic language detection." }, "customVocabulary": { "description": "Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms.", "items": { "type": "string" }, "type": "array" }, "adaptationPhrases": { "description": "Optional. A list of phrases to bias the ASR model towards.", "type": "array", "items": { "type": "string" }, "deprecated": true }, "diarizationMode": { "description": "Optional. Configures speaker diarization. Supported values: \"speaker\".", "type": "string", "deprecated": true }, "timestampGranularities": { "description": "Optional. The granularity of timestamps to include in the transcription output. Supported values: \"word\". If empty, no timestamps are generated.", "items": { "type": "string" }, "type": "array", "deprecated": true } } }, "GoogleCloudAiplatformV1beta1SearchNearestEntitiesResponse": { "id": "GoogleCloudAiplatformV1beta1SearchNearestEntitiesResponse", "description": "Response message for FeatureOnlineStoreService.SearchNearestEntities", "properties": { "nearestNeighbors": { "description": "The nearest neighbors of the query entity.", "$ref": "GoogleCloudAiplatformV1beta1NearestNeighbors" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1TensorboardTimeSeriesMetadata": { "id": "GoogleCloudAiplatformV1beta1TensorboardTimeSeriesMetadata", "properties": { "maxWallTime": { "type": "string", "description": "Output only. Max wall clock timestamp of all data points within a TensorboardTimeSeries.", "format": "google-datetime", "readOnly": true }, "maxStep": { "readOnly": true, "format": "int64", "type": "string", "description": "Output only. Max step index of all data points within a TensorboardTimeSeries." }, "maxBlobSequenceLength": { "format": "int64", "description": "Output only. The largest blob sequence length (number of blobs) of all data points in this time series, if its ValueType is BLOB_SEQUENCE.", "readOnly": true, "type": "string" } }, "description": "Describes metadata for a TensorboardTimeSeries.", "type": "object" }, "CloudAiLargeModelsVisionHumanPose": { "id": "CloudAiLargeModelsVisionHumanPose", "properties": { "bodyLandmarksGcsUri": { "deprecated": true, "description": "GCS URI of the human pose video to condition video generation.", "type": "string" }, "faceLandmarksGcsUri": { "description": "GCS URI of the face landmarks video to condition video generation.", "deprecated": true, "type": "string" }, "perfMeshGcsUri": { "type": "string", "description": "GCS URI of the performance mesh to condition video generation." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1FunctionDeclaration": { "id": "GoogleCloudAiplatformV1beta1FunctionDeclaration", "description": "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.", "properties": { "name": { "description": "Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128.", "type": "string" }, "parameters": { "description": "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", "$ref": "GoogleCloudAiplatformV1beta1Schema" }, "response": { "description": "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.", "$ref": "GoogleCloudAiplatformV1beta1Schema" }, "description": { "type": "string", "description": "Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function." }, "behavior": { "type": "string", "description": "Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method.", "enumDescriptions": [ "This value is unspecified.", "If set, the system will wait to receive the function response before continuing the conversation.", "If set, the system will not wait to receive the function response. Instead, it will attempt to handle function responses as they become available while maintaining the conversation between the user and the model." ], "enum": [ "UNSPECIFIED", "BLOCKING", "NON_BLOCKING" ] }, "parametersJsonSchema": { "description": "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`.", "type": "any" }, "responseJsonSchema": { "description": "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`.", "type": "any" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ReinforcementTuningCloudRunRewardScorer": { "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningCloudRunRewardScorer", "description": "ReinforcementTuningCloudRunRewardScorer allows users to implement a reward function through GCP Cloud Run. Comparing with ReinforcementTuningCodeExecutionRewardScorer that runs in a Sandbox and has no internet access, Cloud Run reward scorer is fully controlled by users. The Cloud Run service should implement the following HTTP API: HTTP method: `POST` HTTP request body: ``` { \"example\": ReinforcementTuningExample, \"response\": Content, \"metadata\": { \"step\": int \"tuning_job_id\": int64 } } ``` * `example` is a ReinforcementTuningExample in ProtoJSON format, (i.e., the format is the same as as one line in the training/validation dataset except that the keys must be in camel case). System instructions (i.e., `example.get(\"systemInstruction\")`) and references (i.e., `example.get(\"references\")`) are also included in the `example` provided that they are set in the training/validation dataset. * `response` is a Content in ProtoJSON format (i.e., keys must be in camel case), which is the same as the Online Prediction response for Gemini models. HTTP response body: { \"reward\": float, \"user_requested_aux_info\": str // Optional } where the field \"user_requested_aux_info\" is any (optional) string provided by users for assisting debugging. It's in snake case. This field is mostly useful when calling the GenAiTuningService.ValidateReinforcementTuningReward API, where the proto field (not Cloud Run HTTP response body) userRequestedAuxInfo will be populated if the Cloud Run reward function sets this field in the HTTP response. The following are examples for the HTTP request and response body. Example HTTP request body: ``` { \"example\": { \"contents\": [ { \"role\": \"user\", \"parts\": [ { \"text\": \"What is the capital of France?\" } ] } ], \"references\": { \"answer\": \"Paris\" } }, \"response\": { \"parts\": [ { \"text\": \"London\" } ] }, \"metadata\": { \"step\": 1, \"tuning_job_id\": 123456789 } } ``` Example HTTP response body: ``` { \"reward\": -1.0 } ``` Note: Reward output by Cloud Run reward function is clipped to be within `[-1, 1]`, i.e., `reward = max(min(reward, 1.0), -1.0)`.", "type": "object", "properties": { "cloudRunUri": { "type": "string", "description": "URI of the Cloud Run service that will be used to compute the reward. The [Vertex AI Secure Fine Tuning Service Agent](https://docs.cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent) (`service-@gcp-sa-vertex-tune.iam.gserviceaccount.com`) must be granted the permission (e.g. by granting `roles/run.invoker` in IAM) to invoke the Cloud Run service." } } }, "GoogleCloudAiplatformV1beta1AutomaticResources": { "id": "GoogleCloudAiplatformV1beta1AutomaticResources", "properties": { "minReplicaCount": { "type": "integer", "description": "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.", "format": "int32" }, "maxReplicaCount": { "description": "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 Agent Platform may be unable to scale beyond certain replica number.", "format": "int32", "type": "integer" } }, "type": "object", "description": "A description of resources that to large degree are decided by Agent Platform, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines." }, "GoogleCloudAiplatformV1beta1FeaturestoreOnlineServingConfig": { "description": "OnlineServingConfig specifies the details for provisioning online serving resources.", "type": "object", "id": "GoogleCloudAiplatformV1beta1FeaturestoreOnlineServingConfig", "properties": { "scaling": { "description": "Online serving scaling configuration. Only one of `fixed_node_count` and `scaling` can be set. Setting one will reset the other.", "$ref": "GoogleCloudAiplatformV1beta1FeaturestoreOnlineServingConfigScaling" }, "fixedNodeCount": { "description": "The number of nodes for the online store. The number of nodes doesn't scale automatically, but you can manually update the number of nodes. If set to 0, the featurestore will not have an online store and cannot be used for online serving.", "format": "int32", "type": "integer" } } }, "GoogleCloudAiplatformV1beta1SchemaVisualInspectionClassificationLabelSavedQueryMetadata": { "properties": { "multiLabel": { "description": "Whether or not the classification label is multi_label.", "type": "boolean" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaVisualInspectionClassificationLabelSavedQueryMetadata" }, "GoogleCloudAiplatformV1beta1PredictRequest": { "properties": { "instances": { "type": "array", "items": { "type": "any" }, "description": "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": { "description": "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.", "type": "any" }, "labels": { "type": "object", "description": "Optional. The user labels for Imagen billing usage only. Only Imagen supports labels. For other use cases, it will be ignored.", "additionalProperties": { "type": "string" } } }, "id": "GoogleCloudAiplatformV1beta1PredictRequest", "description": "Request message for PredictionService.Predict.", "type": "object" }, "GoogleCloudAiplatformV1beta1SandboxEnvironment": { "properties": { "createTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The timestamp when this SandboxEnvironment was created." }, "owner": { "description": "Optional. Owner information for this sandbox environment. A Sandbox can only be restored from a snapshot that belongs to the same owner. If not set, sandbox will be created as the default owner.", "type": "string" }, "ttl": { "type": "string", "format": "google-duration", "description": "Optional. Input only. The TTL for the sandbox environment. The expiration time is computed: now + TTL." }, "state": { "enumDescriptions": [ "The default value. This value is unused.", "Runtime resources are being allocated for the sandbox environment.", "Sandbox runtime is ready for serving.", "Sandbox runtime is halted, performing tear down tasks.", "Sandbox has terminated with underlying runtime failure.", "Sandbox runtime has been deleted.", "Sandbox runtime is paused.", "Sandbox runtime is pausing.", "Sandbox runtime is resuming.", "Sandbox runtime is stopping." ], "enum": [ "STATE_UNSPECIFIED", "STATE_PROVISIONING", "STATE_RUNNING", "STATE_DEPROVISIONING", "STATE_TERMINATED", "STATE_DELETED", "STATE_PAUSED", "STATE_PAUSING", "STATE_RESUMING", "STATE_STOPPING" ], "readOnly": true, "type": "string", "description": "Output only. The runtime state of the SandboxEnvironment." }, "latestSandboxEnvironmentSnapshot": { "description": "Output only. The resource name of the latest snapshot taken for this SandboxEnvironment.", "readOnly": true, "type": "string" }, "connectionInfo": { "description": "Output only. The connection information of the SandboxEnvironment.", "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentConnectionInfo", "readOnly": true }, "expireTime": { "description": "Optional. Timestamp in UTC of when this SandboxEnvironment is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.", "format": "google-datetime", "type": "string" }, "sandboxEnvironmentTemplate": { "type": "string", "description": "Optional. The name of the SandboxEnvironmentTemplate specified in the parent Agent Engine resource that this SandboxEnvironment is created from." }, "sandboxEnvironmentSnapshot": { "type": "string", "description": "Optional. The resource name of the SandboxEnvironmentSnapshot to use for creating this SandboxEnvironment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`" }, "name": { "type": "string", "description": "Identifier. The name of the SandboxEnvironment." }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The timestamp when this SandboxEnvironment was most recently updated.", "type": "string" }, "spec": { "description": "Optional. The configuration of the SandboxEnvironment.", "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentSpec" }, "displayName": { "type": "string", "description": "Required. The display name of the SandboxEnvironment." } }, "description": "SandboxEnvironment is a containerized environment that provides a customizable secure execution runtime for AI agents.", "type": "object", "id": "GoogleCloudAiplatformV1beta1SandboxEnvironment" }, "GoogleCloudAiplatformV1beta1ExportModelOperationMetadataOutputInfo": { "description": "Further describes the output of the ExportModel. Supplements ExportModelRequest.OutputConfig.", "properties": { "artifactOutputUri": { "description": "Output only. If the Model artifact is being exported to Google Cloud Storage this is the full path of the directory created, into which the Model files are being written to.", "type": "string", "readOnly": true }, "imageOutputUri": { "type": "string", "readOnly": true, "description": "Output only. If the Model image is being exported to Google Container Registry or Artifact Registry this is the full path of the image created." } }, "id": "GoogleCloudAiplatformV1beta1ExportModelOperationMetadataOutputInfo", "type": "object" }, "GoogleCloudAiplatformV1beta1ListRagFilesResponse": { "id": "GoogleCloudAiplatformV1beta1ListRagFilesResponse", "type": "object", "description": "Response message for VertexRagDataService.ListRagFiles.", "properties": { "ragFiles": { "description": "List of RagFiles in the requested page.", "items": { "$ref": "GoogleCloudAiplatformV1beta1RagFile" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results. Pass to ListRagFilesRequest.page_token to obtain that page." } } }, "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigHybridSearch": { "description": "Config for Hybrid Search.", "properties": { "alpha": { "type": "number", "format": "float", "description": "Optional. Alpha value controls the weight between dense and sparse vector search results." } }, "id": "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigHybridSearch", "type": "object" }, "GoogleCloudLocationLocation": { "properties": { "metadata": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "Service-specific metadata. For example the available capacity at the given location." }, "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "displayName": { "type": "string", "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\"." }, "labels": { "type": "object", "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "additionalProperties": { "type": "string" } }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" } }, "id": "GoogleCloudLocationLocation", "description": "A resource that represents a Google Cloud location.", "type": "object" }, "GoogleCloudAiplatformV1beta1ModelEvaluationSliceSliceSliceSpecSliceConfig": { "description": "Specification message containing the config for this SliceSpec. When `kind` is selected as `value` and/or `range`, only a single slice will be computed. When `all_values` is present, a separate slice will be computed for each possible label/value for the corresponding key in `config`. Examples, with feature zip_code with values 12345, 23334, 88888 and feature country with values \"US\", \"Canada\", \"Mexico\" in the dataset: Example 1: { \"zip_code\": { \"value\": { \"float_value\": 12345.0 } } } A single slice for any data with zip_code 12345 in the dataset. Example 2: { \"zip_code\": { \"range\": { \"low\": 12345, \"high\": 20000 } } } A single slice containing data where the zip_codes between 12345 and 20000 For this example, data with the zip_code of 12345 will be in this slice. Example 3: { \"zip_code\": { \"range\": { \"low\": 10000, \"high\": 20000 } }, \"country\": { \"value\": { \"string_value\": \"US\" } } } A single slice containing data where the zip_codes between 10000 and 20000 has the country \"US\". For this example, data with the zip_code of 12345 and country \"US\" will be in this slice. Example 4: { \"country\": {\"all_values\": { \"value\": true } } } Three slices are computed, one for each unique country in the dataset. Example 5: { \"country\": { \"all_values\": { \"value\": true } }, \"zip_code\": { \"value\": { \"float_value\": 12345.0 } } } Three slices are computed, one for each unique country in the dataset where the zip_code is also 12345. For this example, data with zip_code 12345 and country \"US\" will be in one slice, zip_code 12345 and country \"Canada\" in another slice, and zip_code 12345 and country \"Mexico\" in another slice, totaling 3 slices.", "properties": { "value": { "description": "A unique specific value for a given feature. Example: `{ \"value\": { \"string_value\": \"12345\" } }`", "$ref": "GoogleCloudAiplatformV1beta1ModelEvaluationSliceSliceSliceSpecValue" }, "range": { "$ref": "GoogleCloudAiplatformV1beta1ModelEvaluationSliceSliceSliceSpecRange", "description": "A range of values for a numerical feature. Example: `{\"range\":{\"low\":10000.0,\"high\":50000.0}}` will capture 12345 and 23334 in the slice." }, "allValues": { "description": "If all_values is set to true, then all possible labels of the keyed feature will have another slice computed. Example: `{\"all_values\":{\"value\":true}}`", "type": "boolean" } }, "id": "GoogleCloudAiplatformV1beta1ModelEvaluationSliceSliceSliceSpecSliceConfig", "type": "object" }, "GoogleCloudAiplatformV1beta1UploadRagFileResponse": { "description": "Response message for VertexRagDataService.UploadRagFile.", "type": "object", "id": "GoogleCloudAiplatformV1beta1UploadRagFileResponse", "properties": { "ragFile": { "description": "The RagFile that had been uploaded into the RagCorpus.", "$ref": "GoogleCloudAiplatformV1beta1RagFile" }, "error": { "description": "The error that occurred while processing the RagFile.", "$ref": "GoogleRpcStatus" } } }, "GoogleCloudAiplatformV1beta1ReasoningEngineSpecBuildSpec": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecBuildSpec", "properties": { "workerPool": { "description": "Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}`", "type": "string" }, "serviceAccount": { "type": "string", "description": "Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com`" } }, "description": "Specification for building container image." }, "GoogleCloudAiplatformV1beta1SchemaVideoObjectTrackingAnnotation": { "description": "Annotation details specific to video object tracking.", "properties": { "annotationSpecId": { "description": "The resource Id of the AnnotationSpec that this Annotation pertains to.", "type": "string" }, "yMin": { "description": "The topmost coordinate of the bounding box.", "type": "number", "format": "double" }, "instanceId": { "description": "The instance of the object, expressed as a positive integer. Used to track the same object across different frames.", "format": "int64", "type": "string" }, "timeOffset": { "format": "google-duration", "type": "string", "description": "A time (frame) of a video to which this annotation pertains. Represented as the duration since the video's start." }, "displayName": { "description": "The display name of the AnnotationSpec that this Annotation pertains to.", "type": "string" }, "yMax": { "type": "number", "format": "double", "description": "The bottommost coordinate of the bounding box." }, "xMin": { "description": "The leftmost coordinate of the bounding box.", "type": "number", "format": "double" }, "xMax": { "description": "The rightmost coordinate of the bounding box.", "type": "number", "format": "double" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaVideoObjectTrackingAnnotation" }, "GoogleCloudAiplatformV1beta1DeleteFeatureValuesOperationMetadata": { "description": "Details of operations that delete Feature values.", "id": "GoogleCloudAiplatformV1beta1DeleteFeatureValuesOperationMetadata", "type": "object", "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "Operation metadata for Featurestore delete Features values." } } }, "GoogleCloudAiplatformV1beta1StudySpecStudyStoppingConfig": { "type": "object", "properties": { "maxNumTrials": { "type": "integer", "description": "If there are more than this many trials, stop the study.", "format": "int32" }, "minNumTrials": { "format": "int32", "description": "If there are fewer than this many COMPLETED trials, do not stop the study.", "type": "integer" }, "maxDurationNoProgress": { "description": "If the objective value has not improved for this much time, stop the study. WARNING: Effective only for single-objective studies.", "format": "google-duration", "type": "string" }, "shouldStopAsap": { "type": "boolean", "description": "If true, a Study enters STOPPING_ASAP whenever it would normally enters STOPPING state. The bottom line is: set to true if you want to interrupt on-going evaluations of Trials as soon as the study stopping condition is met. (Please see Study.State documentation for the source of truth)." }, "minimumRuntimeConstraint": { "description": "Each \"stopping rule\" in this proto specifies an \"if\" condition. Before Vizier would generate a new suggestion, it first checks each specified stopping rule, from top to bottom in this list. Note that the first few rules (e.g. minimum_runtime_constraint, min_num_trials) will prevent other stopping rules from being evaluated until they are met. For example, setting `min_num_trials=5` and `always_stop_after= 1 hour` means that the Study will ONLY stop after it has 5 COMPLETED trials, even if more than an hour has passed since its creation. It follows the first applicable rule (whose \"if\" condition is satisfied) to make a stopping decision. If none of the specified rules are applicable, then Vizier decides that the study should not stop. If Vizier decides that the study should stop, the study enters STOPPING state (or STOPPING_ASAP if should_stop_asap = true). IMPORTANT: The automatic study state transition happens precisely as described above; that is, deleting trials or updating StudyConfig NEVER automatically moves the study state back to ACTIVE. If you want to _resume_ a Study that was stopped, 1) change the stopping conditions if necessary, 2) activate the study, and then 3) ask for suggestions. If the specified time or duration has not passed, do not stop the study.", "$ref": "GoogleCloudAiplatformV1beta1StudyTimeConstraint" }, "maximumRuntimeConstraint": { "description": "If the specified time or duration has passed, stop the study.", "$ref": "GoogleCloudAiplatformV1beta1StudyTimeConstraint" }, "maxNumTrialsNoProgress": { "type": "integer", "format": "int32", "description": "If the objective value has not improved for this many consecutive trials, stop the study. WARNING: Effective only for single-objective studies." } }, "description": "The configuration (stopping conditions) for automated stopping of a Study. Conditions include trial budgets, time budgets, and convergence detection.", "id": "GoogleCloudAiplatformV1beta1StudySpecStudyStoppingConfig" }, "GoogleCloudAiplatformV1beta1FeedbackContext": { "type": "object", "properties": { "name": { "description": "Identifier. The resource name. Assigned by the server on create. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}/feedbackContext`", "type": "string" }, "contextEvents": { "type": "array", "description": "Optional. The session events from the originating session.", "items": { "$ref": "GoogleCloudAiplatformV1beta1SessionEvent" } } }, "id": "GoogleCloudAiplatformV1beta1FeedbackContext", "description": "Feedback context is a resource that represents additional information about the conversation where the feedback was given, such as the conversation history, system instructions, etc. If provided, feedback context allows to correlate the feedback with the conversation, even if the original session is deleted or not available." }, "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentsResponse": { "id": "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentsResponse", "description": "Response message for SandboxEnvironmentService.ListSandboxEnvironments.", "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "A token, which can be sent as ListSandboxEnvironmentsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages." }, "sandboxEnvironments": { "items": { "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironment" }, "type": "array", "description": "The SandboxEnvironments matching the request." } } }, "GoogleCloudAiplatformV1beta1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective": { "properties": { "topFeatureCount": { "type": "integer", "description": "If set, all attribution scores between SearchModelDeploymentMonitoringStatsAnomaliesRequest.start_time and SearchModelDeploymentMonitoringStatsAnomaliesRequest.end_time are fetched, and page token doesn't take effect in this case. Only used to retrieve attribution score for the top Features which has the highest attribution score in the latest monitoring run.", "format": "int32" }, "type": { "enumDescriptions": [ "Default value, should not be set.", "Raw feature values' stats to detect skew between Training-Prediction datasets.", "Raw feature values' stats to detect drift between Serving-Prediction datasets.", "Feature attribution scores to detect skew between Training-Prediction datasets.", "Feature attribution scores to detect skew between Prediction datasets collected within different time windows." ], "enum": [ "MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_TYPE_UNSPECIFIED", "RAW_FEATURE_SKEW", "RAW_FEATURE_DRIFT", "FEATURE_ATTRIBUTION_SKEW", "FEATURE_ATTRIBUTION_DRIFT" ], "type": "string" } }, "description": "Stats requested for specific objective.", "id": "GoogleCloudAiplatformV1beta1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective", "type": "object" }, "GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorerParsedResponseConversionScorer": { "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorerParsedResponseConversionScorer", "type": "object", "properties": {}, "description": "Scores responses by directly converting the parsed autorater response to a float reward. Note: Reward is clipped to be within `[-1, 1]`, i.e., `reward = max(min(reward, 1.0), -1.0)`." }, "GenaiVertexV1beta1GoogleSearchCallStep": { "type": "object", "id": "GenaiVertexV1beta1GoogleSearchCallStep", "properties": { "searchType": { "type": "string", "description": "The type of search grounding enabled.", "enum": [ "SEARCH_TYPE_UNSPECIFIED", "SEARCH_TYPE_WEB_SEARCH", "SEARCH_TYPE_IMAGE_SEARCH", "SEARCH_TYPE_ENTERPRISE_WEB_SEARCH" ], "enumDescriptions": [ "Unspecified search type. This value should not be used.", "Setting this field enables web search. Only text results are returned.", "Setting this field enables image search. Image bytes are returned.", "Setting this field enables enterprise web search." ] }, "arguments": { "$ref": "GenaiVertexV1beta1GoogleSearchCallStepGoogleSearchCallStepArguments", "description": "Required. The arguments to pass to Google Search." } }, "description": "Google Search call step." }, "GoogleCloudAiplatformV1beta1SuspendOnlineEvaluatorRequest": { "properties": {}, "id": "GoogleCloudAiplatformV1beta1SuspendOnlineEvaluatorRequest", "description": "Request message for SuspendOnlineEvaluator.", "type": "object" }, "GoogleCloudAiplatformV1beta1DeployRequestDeployConfig": { "properties": { "fastTryoutEnabled": { "description": "Optional. If true, enable the QMT fast tryout feature for this model if possible.", "type": "boolean" }, "dedicatedResources": { "description": "Optional. The dedicated resources to use for the endpoint. If not set, the default resources will be used.", "$ref": "GoogleCloudAiplatformV1beta1DedicatedResources" }, "systemLabels": { "description": "Optional. System labels for Model Garden deployments. These labels are managed by Google and for tracking purposes only.", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1DeployRequestDeployConfig", "description": "The deploy config to use for the deployment." }, "GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfig": { "description": "The runtime config of a PipelineJob.", "properties": { "defaultRuntime": { "description": "Optional. The default runtime for the PipelineJob. If not set, Standard Vertex Custom Job(https://cloud.google.com/vertex-ai/docs/training/overview) is used as the runtime. If set, all pipeline tasks will run on the default runtime unless a task is a GCPC custom job component (https://cloud.google.com/vertex-ai/docs/pipelines/customjob-component) based task. If the task is based on a GCPC custom job component, it runs solely according to the component's configuration.", "$ref": "GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigDefaultRuntime" }, "gcsOutputDirectory": { "description": "Required. A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-path pattern `{job_id}/{task_id}/{output_key}` under the specified output directory. The service account specified in this pipeline must have the `storage.objects.get` and `storage.objects.create` permissions for this bucket.", "type": "string" }, "parameters": { "type": "object", "description": "Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1Value" }, "deprecated": true }, "inputArtifacts": { "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigInputArtifact" }, "description": "The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact.", "type": "object" }, "parameterValues": { "additionalProperties": { "type": "any" }, "type": "object", "description": "The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL." }, "failurePolicy": { "enumDescriptions": [ "Default value, and follows fail slow behavior.", "Indicates that the pipeline should continue to run until all possible tasks have been scheduled and completed.", "Indicates that the pipeline should stop scheduling new tasks after a task has failed." ], "type": "string", "enum": [ "PIPELINE_FAILURE_POLICY_UNSPECIFIED", "PIPELINE_FAILURE_POLICY_FAIL_SLOW", "PIPELINE_FAILURE_POLICY_FAIL_FAST" ], "description": "Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion." } }, "id": "GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfig", "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingChunkMaps": { "id": "GoogleCloudAiplatformV1beta1GroundingChunkMaps", "properties": { "placeId": { "type": "string", "description": "This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API." }, "placeAnswerSources": { "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources", "description": "The sources that were 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." }, "text": { "description": "The text of the place answer.", "type": "string" }, "title": { "description": "The title of the place.", "type": "string" }, "route": { "description": "Output only. Route information.", "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkMapsRoute" }, "uri": { "type": "string", "description": "The URI of the place." } }, "description": "A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information.", "type": "object" }, "GoogleCloudAiplatformV1beta1DeleteReasoningEngineRuntimeRevisionOperationMetadata": { "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "The common part of the operation metadata." } }, "id": "GoogleCloudAiplatformV1beta1DeleteReasoningEngineRuntimeRevisionOperationMetadata", "type": "object", "description": "Metadata associated with DeleteReasoningEngineRuntimeRevision operation." }, "GoogleCloudAiplatformV1beta1ListModelDeploymentMonitoringJobsResponse": { "type": "object", "description": "Response message for JobService.ListModelDeploymentMonitoringJobs.", "id": "GoogleCloudAiplatformV1beta1ListModelDeploymentMonitoringJobsResponse", "properties": { "modelDeploymentMonitoringJobs": { "description": "A list of ModelDeploymentMonitoringJobs that matches the specified filter in the request.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." } } }, "GoogleCloudAiplatformV1beta1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset": { "type": "object", "id": "GoogleCloudAiplatformV1beta1MigratableResourceDataLabelingDatasetDataLabelingAnnotatedDataset", "properties": { "annotatedDataset": { "description": "Full resource name of data labeling AnnotatedDataset. Format: `projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}`.", "type": "string" }, "annotatedDatasetDisplayName": { "description": "The AnnotatedDataset's display name in datalabeling.googleapis.com.", "type": "string" } }, "description": "Represents one AnnotatedDataset in datalabeling.googleapis.com." }, "GoogleCloudAiplatformV1beta1KeepAliveProbe": { "description": "Represents the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings.", "id": "GoogleCloudAiplatformV1beta1KeepAliveProbe", "type": "object", "properties": { "httpGet": { "description": "Optional. Specifies the HTTP GET configuration for the probe.", "$ref": "GoogleCloudAiplatformV1beta1KeepAliveProbeHttpGet" }, "maxSeconds": { "type": "integer", "description": "Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour).", "format": "int32" } } }, "GenaiVertexV1beta1FunctionCallStep": { "id": "GenaiVertexV1beta1FunctionCallStep", "type": "object", "properties": { "name": { "description": "Required. The name of the tool to call.", "type": "string" }, "arguments": { "$ref": "GenaiVertexV1beta1Struct", "description": "Required. The arguments to pass to the function." } }, "description": "A function tool call step." }, "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigMemoryTopicCustomMemoryTopic": { "description": "A custom memory topic defined by the developer.", "id": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigMemoryTopicCustomMemoryTopic", "properties": { "description": { "description": "Required. Represents the description of the memory topic. This should explain what information should be extracted for this topic.", "type": "string" }, "label": { "description": "Required. Represents the label of the topic.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1BatchCancelPipelineJobsRequest": { "id": "GoogleCloudAiplatformV1beta1BatchCancelPipelineJobsRequest", "properties": { "names": { "type": "array", "items": { "type": "string" }, "description": "Required. The names of the PipelineJobs to cancel. A maximum of 32 PipelineJobs can be cancelled in a batch. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}`" } }, "description": "Request message for PipelineService.BatchCancelPipelineJobs.", "type": "object" }, "GoogleCloudAiplatformV1beta1SandboxEnvironmentSpecShellEnvironment": { "description": "The shell environment.", "type": "object", "properties": {}, "id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentSpecShellEnvironment" }, "GoogleCloudAiplatformV1beta1Skill": { "properties": { "state": { "type": "string", "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "CREATING", "FAILED", "DELETING" ], "description": "Output only. The state of the Skill.", "enumDescriptions": [ "The state of the Skill is unspecified.", "The Skill is active.", "The Skill is being created.", "The Skill was created, but failed to process.", "The Skill is being deleted." ] }, "createTime": { "description": "Output only. Timestamp when this Skill was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "compatibility": { "description": "Optional. Specifies the compatibility of the Skill. Indicates environment requirements (intended product, system packages, network access, etc.). This should align with `compatibility` in the `SKILL.md` file.", "type": "string" }, "description": { "description": "Required. Describes the Skill. Should describe both what the skill does and when to use it. Should include specific keywords that help agents identify relevant tasks. This should align with `description` in the `SKILL.md` file.", "type": "string" }, "skillSource": { "enum": [ "SKILL_SOURCE_UNSPECIFIED", "USER", "SYSTEM" ], "enumDescriptions": [ "The skill source is unspecified.", "The skill is created by a user.", "The skill is a system skill." ], "type": "string", "description": "Output only. The source of the Skill.", "readOnly": true }, "zippedFilesystem": { "description": "Required. Provides the zipped filesystem of the Skill. This should contain the `SKILL.md` file at the root of the zip and optional directories for scripts, references, and assets. Directory should align with the directory structure specified at https://agentskills.io/specification#directory-structure.", "type": "string", "format": "byte" }, "displayName": { "description": "Required. Provides the display name of the Skill. This should align with `name` in the `SKILL.md` file.", "type": "string" }, "updateTime": { "description": "Output only. Timestamp when this Skill was most recently updated.", "format": "google-datetime", "readOnly": true, "type": "string" }, "license": { "description": "Optional. Specifies the license of the Skill. This should be an SPDX license identifier (e.g., \"MIT\", \"Apache-2.0\"). See https://spdx.org/licenses/. This should align with `license` in the `SKILL.md` file.", "type": "string" }, "name": { "description": "Identifier. The resource name of the Skill. Format: `projects/{project}/locations/{location}/skills/{skill}`", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "The labels with user-defined metadata to organize Skills.", "type": "object" }, "sha256": { "readOnly": true, "type": "string", "description": "Output only. The SHA256 checksum of the zipped filesystem." } }, "description": "A skill.", "type": "object", "id": "GoogleCloudAiplatformV1beta1Skill" }, "GoogleCloudAiplatformV1beta1FeatureViewIndexConfigBruteForceConfig": { "id": "GoogleCloudAiplatformV1beta1FeatureViewIndexConfigBruteForceConfig", "properties": {}, "description": "Configuration options for using brute force search.", "type": "object" }, "GoogleCloudAiplatformV1beta1CopyModelRequest": { "type": "object", "id": "GoogleCloudAiplatformV1beta1CopyModelRequest", "description": "Request message for ModelService.CopyModel.", "properties": { "parentModel": { "type": "string", "description": "Optional. Specify this field to copy source_model into this existing Model as a new version. Format: `projects/{project}/locations/{location}/models/{model}`" }, "sourceModel": { "description": "Required. The resource name of the Model to copy. That Model must be in the same Project. Format: `projects/{project}/locations/{location}/models/{model}`", "type": "string" }, "modelId": { "type": "string", "description": "Optional. Copy source_model into a new Model with this ID. The ID will become the final component of the model resource name. This value may be up to 63 characters, and valid characters are `[a-z0-9_-]`. The first character cannot be a number or hyphen." }, "encryptionSpec": { "description": "Customer-managed encryption key options. If this is set, then the Model copy will be encrypted with the provided encryption key.", "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec" }, "customServiceAccount": { "description": "Optional. The user-provided custom service account to use to do the copy model. If empty, [Vertex AI Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) will be used to access resources needed to upload the model. This account must belong to the destination project where the model is copied to, i.e., the project specified in the `parent` field of this request and have the Vertex AI Service Agent role in the source project. Requires the user copying the Model to have the `iam.serviceAccounts.actAs` permission on this service account.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1FeatureViewIndexConfig": { "id": "GoogleCloudAiplatformV1beta1FeatureViewIndexConfig", "properties": { "embeddingDimension": { "description": "Optional. The number of dimensions of the input embedding.", "type": "integer", "format": "int32" }, "embeddingColumn": { "description": "Optional. Column of embedding. This column contains the source data to create index for vector search. embedding_column must be set when using vector search.", "type": "string" }, "distanceMeasureType": { "enum": [ "DISTANCE_MEASURE_TYPE_UNSPECIFIED", "SQUARED_L2_DISTANCE", "COSINE_DISTANCE", "DOT_PRODUCT_DISTANCE" ], "enumDescriptions": [ "Should not be set.", "Euclidean (L_2) Distance.", "Cosine Distance. Defined as 1 - cosine similarity. We strongly suggest using DOT_PRODUCT_DISTANCE + UNIT_L2_NORM instead of COSINE distance. Our algorithms have been more optimized for DOT_PRODUCT distance which, when combined with UNIT_L2_NORM, is mathematically equivalent to COSINE distance and results in the same ranking.", "Dot Product Distance. Defined as a negative of the dot product." ], "type": "string", "description": "Optional. The distance measure used in nearest neighbor search." }, "bruteForceConfig": { "description": "Optional. Configuration options for using brute force search, which simply implements the standard linear search in the database for each query. It is primarily meant for benchmarking and to generate the ground truth for approximate search.", "$ref": "GoogleCloudAiplatformV1beta1FeatureViewIndexConfigBruteForceConfig" }, "filterColumns": { "items": { "type": "string" }, "type": "array", "description": "Optional. Columns of features that're used to filter vector search results." }, "treeAhConfig": { "description": "Optional. Configuration options for the tree-AH algorithm (Shallow tree + Asymmetric Hashing). Please refer to this paper for more details: https://arxiv.org/abs/1908.10396", "$ref": "GoogleCloudAiplatformV1beta1FeatureViewIndexConfigTreeAHConfig" }, "crowdingColumn": { "description": "Optional. Column of crowding. This column contains crowding attribute which is a constraint on a neighbor list produced by FeatureOnlineStoreService.SearchNearestEntities to diversify search results. If NearestNeighborQuery.per_crowding_attribute_neighbor_count is set to K in SearchNearestEntitiesRequest, it's guaranteed that no more than K entities of the same crowding attribute are returned in the response.", "type": "string" } }, "type": "object", "description": "Configuration for vector indexing." }, "GoogleCloudAiplatformV1beta1PipelineTaskDetailPipelineTaskStatus": { "description": "A single record of the task status.", "type": "object", "id": "GoogleCloudAiplatformV1beta1PipelineTaskDetailPipelineTaskStatus", "properties": { "state": { "enum": [ "STATE_UNSPECIFIED", "PENDING", "RUNNING", "SUCCEEDED", "CANCEL_PENDING", "CANCELLING", "CANCELLED", "FAILED", "SKIPPED", "NOT_TRIGGERED" ], "description": "Output only. The state of the task.", "enumDescriptions": [ "Unspecified.", "Specifies pending state for the task.", "Specifies task is being executed.", "Specifies task completed successfully.", "Specifies Task cancel is in pending state.", "Specifies task is being cancelled.", "Specifies task was cancelled.", "Specifies task failed.", "Specifies task was skipped due to cache hit.", "Specifies that the task was not triggered because the task's trigger policy is not satisfied. The trigger policy is specified in the `condition` field of PipelineJob.pipeline_spec." ], "readOnly": true, "type": "string" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. Update time of this status.", "readOnly": true }, "error": { "description": "Output only. The error that occurred during the state. May be set when the state is any of the non-final state (PENDING/RUNNING/CANCELLING) or FAILED state. If the state is FAILED, the error here is final and not going to be retried. If the state is a non-final state, the error indicates a system-error being retried.", "$ref": "GoogleRpcStatus", "readOnly": true } } }, "GenaiVertexV1beta1UrlContextResultContentUrlContextResult": { "description": "The result of the URL context.", "properties": { "url": { "description": "The URL that was fetched.", "type": "string" }, "status": { "description": "The status of the URL retrieval.", "enum": [ "STATUS_UNSPECIFIED", "SUCCESS", "ERROR", "PAYWALL", "UNSAFE" ], "type": "string", "enumDescriptions": [ "Unspecified status. This value should not be used.", "Url retrieval is successful.", "Url retrieval is failed due to error.", "Url retrieval is failed because the content is behind paywall.", "Url retrieval is failed because the content is unsafe." ] } }, "type": "object", "id": "GenaiVertexV1beta1UrlContextResultContentUrlContextResult" }, "GoogleCloudAiplatformV1beta1TrajectoryRecallSpec": { "id": "GoogleCloudAiplatformV1beta1TrajectoryRecallSpec", "type": "object", "properties": {}, "description": "Spec for TrajectoryRecall metric - returns a float score based on average recall of individual tool calls." }, "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveConfigTrainingDataset": { "id": "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveConfigTrainingDataset", "properties": { "dataFormat": { "description": "Data format of the dataset, only applicable if the input is from Google Cloud Storage. The possible formats are: \"tf-record\" The source file is a TFRecord file. \"csv\" The source file is a CSV file. \"jsonl\" The source file is a JSONL file.", "type": "string" }, "targetField": { "type": "string", "description": "The target field name the model is to predict. This field will be excluded when doing Predict and (or) Explain for the training data." }, "loggingSamplingStrategy": { "description": "Strategy to sample data from Training Dataset. If not set, we process the whole dataset.", "$ref": "GoogleCloudAiplatformV1beta1SamplingStrategy" }, "dataset": { "description": "The resource name of the Dataset used to train this Model.", "type": "string" }, "bigquerySource": { "description": "The BigQuery table of the unmanaged Dataset used to train this Model.", "$ref": "GoogleCloudAiplatformV1beta1BigQuerySource" }, "gcsSource": { "description": "The Google Cloud Storage uri of the unmanaged Dataset used to train this Model.", "$ref": "GoogleCloudAiplatformV1beta1GcsSource" } }, "type": "object", "description": "Training Dataset information." }, "GoogleCloudAiplatformV1beta1Index": { "type": "object", "id": "GoogleCloudAiplatformV1beta1Index", "description": "A representation of a collection of database items organized in a way that allows for approximate nearest neighbor (a.k.a ANN) algorithms search.", "properties": { "indexStats": { "description": "Output only. Stats of the index resource.", "$ref": "GoogleCloudAiplatformV1beta1IndexStats", "readOnly": true }, "labels": { "description": "The labels with user-defined metadata to organize your Indexes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.", "type": "object", "additionalProperties": { "type": "string" } }, "metadata": { "type": "any", "description": "An additional information about the Index; the schema of the metadata can be found in metadata_schema." }, "encryptionSpec": { "description": "Immutable. Customer-managed encryption key spec for an Index. If set, this Index and all sub-resources of this Index will be secured by this key.", "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec" }, "updateTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.", "type": "string" }, "etag": { "type": "string", "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens." }, "deployedIndexes": { "items": { "$ref": "GoogleCloudAiplatformV1beta1DeployedIndexRef" }, "readOnly": true, "type": "array", "description": "Output only. The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first." }, "displayName": { "description": "Required. The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.", "type": "string" }, "createTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. Timestamp when this Index was created." }, "satisfiesPzi": { "readOnly": true, "type": "boolean", "description": "Output only. Reserved for future use." }, "name": { "description": "Output only. The resource name of the Index.", "readOnly": true, "type": "string" }, "metadataSchemaUri": { "type": "string", "description": "Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. 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). 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." }, "description": { "description": "The description of the Index.", "type": "string" }, "satisfiesPzs": { "readOnly": true, "description": "Output only. Reserved for future use.", "type": "boolean" }, "indexUpdateMethod": { "description": "Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.", "enum": [ "INDEX_UPDATE_METHOD_UNSPECIFIED", "BATCH_UPDATE", "STREAM_UPDATE" ], "type": "string", "enumDescriptions": [ "Should not be used.", "BatchUpdate: user can call UpdateIndex with files on Cloud Storage of Datapoints to update.", "StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update the Index and the updates will be applied in corresponding DeployedIndexes in nearly real-time." ] } } }, "GoogleCloudAiplatformV1beta1Value": { "type": "object", "id": "GoogleCloudAiplatformV1beta1Value", "properties": { "stringValue": { "description": "A string value.", "type": "string" }, "doubleValue": { "format": "double", "type": "number", "description": "A double value." }, "intValue": { "description": "An integer value.", "type": "string", "format": "int64" } }, "description": "Value is the value of the field." }, "GoogleCloudAiplatformV1beta1SearchExamplesRequest": { "properties": { "storedContentsExampleParameters": { "$ref": "GoogleCloudAiplatformV1beta1StoredContentsExampleParameters", "description": "The parameters of StoredContentsExamples to be searched." }, "topK": { "format": "int64", "description": "Optional. The number of similar examples to return.", "type": "string" } }, "description": "Request message for ExampleStoreService.SearchExamples.", "id": "GoogleCloudAiplatformV1beta1SearchExamplesRequest", "type": "object" }, "GenaiVertexV1beta1ParallelAISearchConfig": { "properties": { "customConfig": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional. Custom configs for ParallelAiSearch.", "type": "object" }, "apiKey": { "type": "string", "description": "Optional. The API key for ParallelAiSearch." } }, "description": "Used to specify configuration for ParallelAISearch.", "type": "object", "id": "GenaiVertexV1beta1ParallelAISearchConfig" }, "GoogleCloudAiplatformV1beta1LookupStudyRequest": { "type": "object", "id": "GoogleCloudAiplatformV1beta1LookupStudyRequest", "properties": { "displayName": { "type": "string", "description": "Required. The user-defined display name of the Study" } }, "description": "Request message for VizierService.LookupStudy." }, "GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualityResult": { "description": "Spec for pairwise question answering quality result.", "id": "GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualityResult", "properties": { "confidence": { "readOnly": true, "description": "Output only. Confidence for question answering quality score.", "type": "number", "format": "float" }, "pairwiseChoice": { "enum": [ "PAIRWISE_CHOICE_UNSPECIFIED", "BASELINE", "CANDIDATE", "TIE" ], "description": "Output only. Pairwise question answering prediction choice.", "readOnly": true, "enumDescriptions": [ "Unspecified prediction choice.", "Baseline prediction wins", "Candidate prediction wins", "Winner cannot be determined" ], "type": "string" }, "explanation": { "readOnly": true, "type": "string", "description": "Output only. Explanation for question answering quality score." } }, "type": "object" }, "GenaiVertexV1beta1VideoContentMediaProcessing": { "type": "object", "properties": { "static": { "$ref": "GenaiVertexV1beta1VideoContentStaticMediaProcessing" } }, "id": "GenaiVertexV1beta1VideoContentMediaProcessing" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageSegmentationInputs", "properties": { "budgetMilliNodeHours": { "description": "The training budget of creating this model, expressed in milli node hours i.e. 1,000 value in this field means 1 node hour. The actual metadata.costMilliNodeHours will be equal or less than this value. If further model training ceases to provide any improvements, it will stop without using the full budget and the metadata.successfulStopReason will be `model-converged`. Note, node_hour = actual_hour * number_of_nodes_involved. Or actual_wall_clock_hours = train_budget_milli_node_hours / (number_of_nodes_involved * 1000) For modelType `cloud-high-accuracy-1`(default), the budget must be between 20,000 and 2,000,000 milli node hours, inclusive. The default value is 192,000 which represents one day in wall time (1000 milli * 24 hours * 8 nodes).", "format": "int64", "type": "string" }, "modelType": { "type": "string", "enum": [ "MODEL_TYPE_UNSPECIFIED", "CLOUD_HIGH_ACCURACY_1", "CLOUD_LOW_ACCURACY_1", "MOBILE_TF_LOW_LATENCY_1" ], "enumDescriptions": [ "Should not be set.", "A model to be used via prediction calls to uCAIP API. Expected to have a higher latency, but should also have a higher prediction quality than other models.", "A model to be used via prediction calls to uCAIP API. Expected to have a lower latency but relatively lower prediction quality.", "A model that, in addition to being available within Google Cloud, can also be exported (see ModelService.ExportModel) as TensorFlow model and used on a mobile or edge device afterwards. Expected to have low latency, but may have lower prediction quality than other mobile models." ] }, "baseModelId": { "type": "string", "description": "The ID of the `base` model. If it is specified, the new model will be trained based on the `base` model. Otherwise, the new model will be trained from scratch. The `base` model must be in the same Project and Location as the new Model to train, and have the same modelType." } } }, "GoogleCloudAiplatformV1beta1ExportPublisherModelRequest": { "type": "object", "properties": { "destination": { "description": "Required. The target where we are exporting the model weights to", "$ref": "GoogleCloudAiplatformV1beta1GcsDestination" } }, "description": "Request message for ModelGardenService.ExportPublisherModel.", "id": "GoogleCloudAiplatformV1beta1ExportPublisherModelRequest" }, "GenaiVertexV1beta1LocalEnvironmentConfig": { "type": "object", "description": "Configuration for an environment that lives on the client connection rather than in a server-managed sandbox. When set (via Interaction.local_environment), the agent's filesystem and shell are treated as living on the client: the agent's built-in environment operations (e.g. reading/listing/editing files and running commands) are suspended on the server and yielded back to the client to execute, with their results returned on a subsequent turn. This is mutually exclusive with a server-managed `EnvironmentConfig` (remote_environment), since the environment is either on the client or in a server sandbox, never both. This governs only the agent's built-in environment. Client-declared function tools are always executed on the client regardless of this field.", "id": "GenaiVertexV1beta1LocalEnvironmentConfig", "properties": {} }, "GenaiVertexV1beta1EnvironmentConfig": { "id": "GenaiVertexV1beta1EnvironmentConfig", "type": "object", "properties": { "networkAllowlist": { "$ref": "GenaiVertexV1beta1EnvironmentConfigEnvironmentNetworkEgressAllowlist", "description": "Allow only specific domains." }, "sources": { "items": { "$ref": "GenaiVertexV1beta1EnvironmentConfigSource" }, "type": "array" }, "environmentId": { "description": "Optional. The environment ID for the interaction. If specified, the request will update the existing environment instead of creating a new one.", "type": "string" }, "networkMode": { "description": "Network egress mode.", "enumDescriptions": [ "Default value. Unused.", "All network egress is blocked." ], "type": "string", "enum": [ "NETWORK_MODE_UNSPECIFIED", "DISABLED" ] } }, "description": "Configuration for a custom environment." }, "GoogleCloudAiplatformV1beta1CachedContentUsageMetadata": { "properties": { "videoDurationSeconds": { "format": "int32", "type": "integer", "description": "Duration of video in seconds." }, "imageCount": { "type": "integer", "format": "int32", "description": "Number of images." }, "audioDurationSeconds": { "format": "int32", "type": "integer", "description": "Duration of audio in seconds." }, "textCount": { "type": "integer", "description": "Number of text characters.", "format": "int32" }, "totalTokenCount": { "description": "Total number of tokens that the cached content consumes.", "type": "integer", "format": "int32" } }, "description": "Metadata on the usage of the cached content.", "id": "GoogleCloudAiplatformV1beta1CachedContentUsageMetadata", "type": "object" }, "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateCustomContainerEnvironment": { "properties": { "resources": { "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateResourceRequirements", "description": "Resource requests and limits for the container." }, "customContainerSpec": { "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateCustomContainerSpec", "description": "The specification of the custom container environment." }, "ports": { "items": { "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateNetworkPort" }, "type": "array", "description": "Ports to expose from the container." } }, "id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateCustomContainerEnvironment", "type": "object", "description": "The customized sandbox runtime environment for BYOC." }, "GoogleCloudAiplatformV1beta1PublisherModel": { "properties": { "versionState": { "description": "Optional. Indicates the state of the model version.", "enumDescriptions": [ "The version state is unspecified.", "Used to indicate the version is stable.", "Used to indicate the version is unstable." ], "type": "string", "enum": [ "VERSION_STATE_UNSPECIFIED", "VERSION_STATE_STABLE", "VERSION_STATE_UNSTABLE" ] }, "openSourceCategory": { "enumDescriptions": [ "The open source category is unspecified, which should not be used.", "Used to indicate the PublisherModel is not open sourced.", "Used to indicate the PublisherModel is a Google-owned open source model w/ Google checkpoint.", "Used to indicate the PublisherModel is a 3p-owned open source model w/ Google checkpoint.", "Used to indicate the PublisherModel is a Google-owned pure open source model.", "Used to indicate the PublisherModel is a 3p-owned pure open source model." ], "type": "string", "enum": [ "OPEN_SOURCE_CATEGORY_UNSPECIFIED", "PROPRIETARY", "GOOGLE_OWNED_OSS_WITH_GOOGLE_CHECKPOINT", "THIRD_PARTY_OWNED_OSS_WITH_GOOGLE_CHECKPOINT", "GOOGLE_OWNED_OSS", "THIRD_PARTY_OWNED_OSS" ], "description": "Required. Indicates the open source category of the publisher model." }, "publisherModelTemplate": { "type": "string", "description": "Optional. Output only. Immutable. Used to indicate this model has a publisher model and provide the template of the publisher model resource name.", "readOnly": true }, "predictSchemata": { "description": "Optional. The schemata that describes formats of the PublisherModel's predictions and explanations as given and returned via PredictionService.Predict.", "$ref": "GoogleCloudAiplatformV1beta1PredictSchemata" }, "frameworks": { "type": "array", "items": { "type": "string" }, "description": "Optional. Additional information about the model's Frameworks." }, "versionId": { "readOnly": true, "description": "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.", "type": "string" }, "supportedActions": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToAction", "description": "Optional. Supported call-to-action options." }, "parent": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelParent", "description": "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." }, "name": { "readOnly": true, "description": "Output only. Identifier. The resource name of the PublisherModel.", "type": "string" }, "launchStage": { "type": "string", "description": "Optional. Indicates the launch stage of the model.", "enum": [ "LAUNCH_STAGE_UNSPECIFIED", "EXPERIMENTAL", "PRIVATE_PREVIEW", "PUBLIC_PREVIEW", "GA" ], "enumDescriptions": [ "The model launch stage is unspecified.", "Used to indicate the PublisherModel is at Experimental launch stage, available to a small set of customers.", "Used to indicate the PublisherModel is at Private Preview launch stage, only available to a small set of customers, although a larger set of customers than an Experimental launch. Previews are the first launch stage used to get feedback from customers.", "Used to indicate the PublisherModel is at Public Preview launch stage, available to all customers, although not supported for production workloads.", "Used to indicate the PublisherModel is at GA launch stage, available to all customers and ready for production workload." ] } }, "description": "A Model Garden Publisher Model.", "type": "object", "id": "GoogleCloudAiplatformV1beta1PublisherModel" }, "GoogleCloudAiplatformV1beta1VeoLoraTuningSpec": { "id": "GoogleCloudAiplatformV1beta1VeoLoraTuningSpec", "type": "object", "description": "Tuning Spec for Veo LoRA Model Tuning.", "properties": { "validationDatasetUri": { "description": "Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.", "type": "string" }, "videoOrientation": { "enum": [ "VIDEO_ORIENTATION_UNSPECIFIED", "LANDSCAPE", "PORTRAIT" ], "type": "string", "enumDescriptions": [ "Unspecified video orientation. Defaults to landscape.", "Landscape orientation (e.g. 16:9, 1280x720).", "Portrait orientation (e.g. 9:16, 720x1280)." ], "description": "Optional. The orientation of the video. Defaults to LANDSCAPE." }, "hyperParameters": { "description": "Optional. Hyperparameters for Veo LoRA.", "$ref": "GoogleCloudAiplatformV1beta1VeoHyperParameters" }, "trainingDatasetUri": { "description": "Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1MigrateResourceRequestMigrateAutomlDatasetConfig": { "id": "GoogleCloudAiplatformV1beta1MigrateResourceRequestMigrateAutomlDatasetConfig", "type": "object", "properties": { "dataset": { "description": "Required. Full resource name of automl Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`.", "type": "string" }, "datasetDisplayName": { "type": "string", "description": "Required. Display name of the Dataset in Vertex AI. System will pick a display name if unspecified." } }, "description": "Config for migrating Dataset in automl.googleapis.com to Vertex AI's Dataset." }, "GoogleCloudAiplatformV1beta1ModelMonitoringInputModelMonitoringDataset": { "description": "Input dataset spec.", "type": "object", "properties": { "vertexDataset": { "description": "Resource name of the Vertex AI managed dataset.", "type": "string" }, "gcsSource": { "description": "Google Cloud Storage data source.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringInputModelMonitoringDatasetModelMonitoringGcsSource" }, "timestampField": { "type": "string", "description": "The timestamp field. Usually for serving data." }, "bigquerySource": { "description": "BigQuery data source.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringInputModelMonitoringDatasetModelMonitoringBigQuerySource" } }, "id": "GoogleCloudAiplatformV1beta1ModelMonitoringInputModelMonitoringDataset" }, "GoogleCloudAiplatformV1beta1SafetySetting": { "description": "A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.", "properties": { "category": { "description": "Required. The harm category to be blocked.", "type": "string", "enum": [ "HARM_CATEGORY_UNSPECIFIED", "HARM_CATEGORY_HATE_SPEECH", "HARM_CATEGORY_DANGEROUS_CONTENT", "HARM_CATEGORY_HARASSMENT", "HARM_CATEGORY_SEXUALLY_EXPLICIT", "HARM_CATEGORY_CIVIC_INTEGRITY", "HARM_CATEGORY_IMAGE_HATE", "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT", "HARM_CATEGORY_IMAGE_HARASSMENT", "HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT", "HARM_CATEGORY_JAILBREAK" ], "enumDescriptions": [ "Default value. This value is unused.", "Content that promotes violence or incites hatred against individuals or groups based on certain attributes.", "Content that promotes, facilitates, or enables dangerous activities.", "Abusive, threatening, or content intended to bully, torment, or ridicule.", "Content that contains sexually explicit material.", "Deprecated: Election filter is not longer supported. The harm category is civic integrity.", "Images that contain hate speech.", "Images that contain dangerous content.", "Images that contain harassment.", "Images that contain sexually explicit content.", "Prompts designed to bypass safety filters." ], "enumDeprecated": [ false, false, false, false, false, true, false, false, false, false, false ] }, "method": { "enumDescriptions": [ "The harm block method is unspecified.", "The harm block method uses both probability and severity scores.", "The harm block method uses the probability score." ], "enum": [ "HARM_BLOCK_METHOD_UNSPECIFIED", "SEVERITY", "PROBABILITY" ], "description": "Optional. The method for blocking content. If not specified, the default behavior is to use the probability score.", "type": "string" }, "threshold": { "enumDescriptions": [ "The harm block threshold is unspecified.", "Block content with a low harm probability or higher.", "Block content with a medium harm probability or higher.", "Block content with a high harm probability.", "Do not block any content, regardless of its harm probability.", "Turn off the safety filter entirely." ], "type": "string", "description": "Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked.", "enum": [ "HARM_BLOCK_THRESHOLD_UNSPECIFIED", "BLOCK_LOW_AND_ABOVE", "BLOCK_MEDIUM_AND_ABOVE", "BLOCK_ONLY_HIGH", "BLOCK_NONE", "OFF" ] } }, "id": "GoogleCloudAiplatformV1beta1SafetySetting", "type": "object" }, "GoogleCloudAiplatformV1beta1TrajectoryAnyOrderMatchInput": { "id": "GoogleCloudAiplatformV1beta1TrajectoryAnyOrderMatchInput", "properties": { "instances": { "type": "array", "description": "Required. Repeated TrajectoryAnyOrderMatch instance.", "items": { "$ref": "GoogleCloudAiplatformV1beta1TrajectoryAnyOrderMatchInstance" } }, "metricSpec": { "$ref": "GoogleCloudAiplatformV1beta1TrajectoryAnyOrderMatchSpec", "description": "Required. Spec for TrajectoryAnyOrderMatch metric." } }, "description": "Instances and metric spec for TrajectoryAnyOrderMatch metric.", "type": "object" }, "GoogleCloudAiplatformV1beta1BatchImportModelEvaluationSlicesResponse": { "description": "Response message for ModelService.BatchImportModelEvaluationSlices", "type": "object", "properties": { "importedModelEvaluationSlices": { "description": "Output only. List of imported ModelEvaluationSlice.name.", "type": "array", "items": { "type": "string" }, "readOnly": true } }, "id": "GoogleCloudAiplatformV1beta1BatchImportModelEvaluationSlicesResponse" }, "GenaiVertexV1beta1ReviewSnippet": { "id": "GenaiVertexV1beta1ReviewSnippet", "description": "Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.", "properties": { "url": { "type": "string", "description": "A link that corresponds to the user review on Google Maps." }, "reviewId": { "type": "string", "description": "The ID of the review snippet." }, "title": { "type": "string", "description": "Title of the review." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1UpgradeNotebookRuntimeOperationMetadata": { "description": "Metadata information for NotebookService.UpgradeNotebookRuntime.", "properties": { "genericMetadata": { "description": "The operation generic information.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" }, "progressMessage": { "type": "string", "description": "A human-readable message that shows the intermediate progress details of NotebookRuntime." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1UpgradeNotebookRuntimeOperationMetadata" }, "GoogleCloudAiplatformV1beta1GoogleMapsGroundingTypes": { "description": "Defines the types of Google Maps grounding that can be enabled and their configurations.", "properties": { "places": { "description": "Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified.", "$ref": "GoogleCloudAiplatformV1beta1GoogleMapsPlaces" }, "routing": { "$ref": "GoogleCloudAiplatformV1beta1GoogleMapsRouting", "description": "Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute)." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1GoogleMapsGroundingTypes" }, "GoogleCloudAiplatformV1beta1BleuMetricValue": { "id": "GoogleCloudAiplatformV1beta1BleuMetricValue", "properties": { "score": { "type": "number", "description": "Output only. Bleu score.", "readOnly": true, "format": "float" } }, "description": "Bleu metric value for an instance.", "type": "object" }, "GoogleCloudAiplatformV1beta1Fact": { "properties": { "summary": { "description": "If present, the summary/snippet of the fact.", "type": "string" }, "uri": { "description": "If present, this uri links to the source of the fact.", "type": "string" }, "query": { "description": "Query that is used to retrieve this fact.", "type": "string" }, "title": { "description": "If present, it refers to the title of this fact.", "type": "string" }, "chunk": { "description": "If present, chunk properties.", "$ref": "GoogleCloudAiplatformV1beta1RagChunk" }, "vectorDistance": { "type": "number", "format": "double", "description": "If present, the distance between the query vector and this fact vector.", "deprecated": true }, "score": { "format": "double", "type": "number", "description": "If present, according to the underlying Vector DB and the selected metric type, the score can be either the distance or the similarity between the query and the fact and its range depends on the metric type. For example, if the metric type is COSINE_DISTANCE, it represents the distance between the query and the fact. The larger the distance, the less relevant the fact is to the query. The range is [0, 2], while 0 means the most relevant and 2 means the least relevant." } }, "description": "The fact used in grounding.", "id": "GoogleCloudAiplatformV1beta1Fact", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaTextSentimentSavedQueryMetadata": { "id": "GoogleCloudAiplatformV1beta1SchemaTextSentimentSavedQueryMetadata", "type": "object", "description": "The metadata of SavedQuery contains TextSentiment Annotations.", "properties": { "sentimentMax": { "format": "int32", "type": "integer", "description": "The maximum sentiment of sentiment Anntoation in this SavedQuery." } } }, "GoogleCloudAiplatformV1beta1DeployIndexRequest": { "type": "object", "properties": { "deployedIndex": { "description": "Required. The DeployedIndex to be created within the IndexEndpoint.", "$ref": "GoogleCloudAiplatformV1beta1DeployedIndex" } }, "description": "Request message for IndexEndpointService.DeployIndex.", "id": "GoogleCloudAiplatformV1beta1DeployIndexRequest" }, "GenaiVertexV1beta1CodeExecutionResultContent": { "description": "Code execution result content.", "id": "GenaiVertexV1beta1CodeExecutionResultContent", "deprecated": true, "properties": { "isError": { "description": "Whether the code execution resulted in an error.", "type": "boolean" }, "result": { "description": "Required. The output of the code execution.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1MetricxInput": { "description": "Input for MetricX metric.", "id": "GoogleCloudAiplatformV1beta1MetricxInput", "type": "object", "properties": { "metricSpec": { "description": "Required. Spec for Metricx metric.", "$ref": "GoogleCloudAiplatformV1beta1MetricxSpec" }, "instance": { "description": "Required. Metricx instance.", "$ref": "GoogleCloudAiplatformV1beta1MetricxInstance" } } }, "GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntime": { "type": "object", "properties": { "customContainerImage": { "description": "A user-provided container image. The notebook executes inside this container on a managed container-host (COS) VM.", "$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeContainerImage" }, "vmImage": { "$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeVmImage", "description": "A specific Compute Engine VM image to run the notebook on." } }, "description": "Configuration for a Workbench Instances-based environment.", "id": "GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntime" }, "GoogleCloudAiplatformV1beta1SyncFeatureViewRequest": { "description": "Request message for FeatureOnlineStoreAdminService.SyncFeatureView.", "type": "object", "id": "GoogleCloudAiplatformV1beta1SyncFeatureViewRequest", "properties": {} }, "GoogleCloudAiplatformV1beta1TaskMetadataChange": { "id": "GoogleCloudAiplatformV1beta1TaskMetadataChange", "description": "An event representing a change to the task's top-level metadata. example: metadata_change: { new_metadata: { \"name\": \"My task\", } update_mask: { paths: \"name\" } }", "properties": { "newMetadata": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Required. The complete state of the metadata object *after* the change." }, "updateMask": { "description": "Optional. A field mask indicating which paths in the Struct were changed. If not set, all fields will be updated. go/aip-internal/cloud-standard/2412", "format": "google-fieldmask", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ListExecutionsResponse": { "properties": { "executions": { "description": "The Executions retrieved from the MetadataStore.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Execution" } }, "nextPageToken": { "description": "A token, which can be sent as ListExecutionsRequest.page_token to retrieve the next page. If this field is not populated, there are no subsequent pages.", "type": "string" } }, "type": "object", "description": "Response message for MetadataService.ListExecutions.", "id": "GoogleCloudAiplatformV1beta1ListExecutionsResponse" }, "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsTextExtractionEvaluationMetrics": { "id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsTextExtractionEvaluationMetrics", "type": "object", "properties": { "confusionMatrix": { "description": "Confusion matrix of the evaluation. Only set for Models where number of AnnotationSpecs is no more than 10. Only set for ModelEvaluations, not for ModelEvaluationSlices.", "$ref": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsConfusionMatrix" }, "confidenceMetrics": { "description": "Metrics that have confidence thresholds. Precision-recall curve can be derived from them.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsTextExtractionEvaluationMetricsConfidenceMetrics" } } }, "description": "Metrics for text extraction evaluation results." }, "GoogleCloudAiplatformV1beta1SchemaMultimodalDatasetMetadataMultimodalDatasetInputConfig": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaMultimodalDatasetMetadataMultimodalDatasetInputConfig", "description": "Specifies the input source and configuration.", "properties": { "bigquerySource": { "$ref": "GoogleCloudAiplatformV1beta1SchemaMultimodalDatasetMetadataBigQuerySource", "description": "BigQuery source table." } } }, "GoogleCloudAiplatformV1beta1ErrorAnalysisAnnotation": { "properties": { "outlierScore": { "description": "The outlier score of this annotated item. Usually defined as the min of all distances from attributed items.", "type": "number", "format": "double" }, "attributedItems": { "items": { "$ref": "GoogleCloudAiplatformV1beta1ErrorAnalysisAnnotationAttributedItem" }, "type": "array", "description": "Attributed items for a given annotation, typically representing neighbors from the training sets constrained by the query type." }, "outlierThreshold": { "type": "number", "description": "The threshold used to determine if this annotation is an outlier or not.", "format": "double" }, "queryType": { "enumDescriptions": [ "Unspecified query type for model error analysis.", "Query similar samples across all classes in the dataset.", "Query similar samples from the same class of the input sample.", "Query dissimilar samples from the same class of the input sample." ], "description": "The query type used for finding the attributed items.", "type": "string", "enum": [ "QUERY_TYPE_UNSPECIFIED", "ALL_SIMILAR", "SAME_CLASS_SIMILAR", "SAME_CLASS_DISSIMILAR" ] } }, "description": "Model error analysis for each annotation.", "id": "GoogleCloudAiplatformV1beta1ErrorAnalysisAnnotation", "type": "object" }, "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData": { "type": "object", "description": "Instance data used to populate placeholders in a metric prompt template.", "id": "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData", "properties": { "text": { "description": "Text data.", "type": "string" }, "contents": { "description": "List of Gemini content data.", "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceDataContents" } } }, "GoogleCloudAiplatformV1beta1FunctionCallingConfig": { "id": "GoogleCloudAiplatformV1beta1FunctionCallingConfig", "description": "Function calling config.", "properties": { "streamFunctionCallArguments": { "description": "Optional. When set to true, arguments of a single function call will be streamed out in multiple parts/contents/responses. Partial parameter results will be returned in the `FunctionCall.partial_args` field.", "type": "boolean" }, "mode": { "enumDescriptions": [ "Unspecified function calling mode. This value should not be used.", "Default model behavior, model decides to predict either function calls or natural language response.", "Model is constrained to always predicting function calls only. If \"allowed_function_names\" are set, the predicted function calls will be limited to any one of \"allowed_function_names\", else the predicted function calls will be any one of the provided \"function_declarations\".", "Model will not predict any function calls. Model behavior is same as when not passing any function declarations.", "Model is constrained to predict either function calls or natural language response. If \"allowed_function_names\" are set, the predicted function calls will be limited to any one of \"allowed_function_names\", else the predicted function calls will be any one of the provided \"function_declarations\"." ], "enum": [ "MODE_UNSPECIFIED", "AUTO", "ANY", "NONE", "VALIDATED" ], "description": "Optional. Function calling mode.", "type": "string" }, "allowedFunctionNames": { "type": "array", "description": "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.", "items": { "type": "string" } } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ModelMonitorModelMonitoringTarget": { "description": "The monitoring target refers to the entity that is subject to analysis. e.g. Vertex AI Model version.", "id": "GoogleCloudAiplatformV1beta1ModelMonitorModelMonitoringTarget", "properties": { "vertexModel": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitorModelMonitoringTargetVertexModelSource", "description": "Model in Vertex AI Model Registry." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1CompletionStats": { "type": "object", "description": "Success and error statistics of processing multiple entities (for example, DataItems or structured data rows) in batch.", "properties": { "incompleteCount": { "readOnly": true, "description": "Output only. In cases when enough errors are encountered a job, pipeline, or operation may be failed as a whole. Below is the number of entities for which the processing had not been finished (either in successful or failed state). Set to -1 if the number is unknown (for example, the operation failed before the total entity number could be collected).", "format": "int64", "type": "string" }, "successfulCount": { "type": "string", "description": "Output only. The number of entities that had been processed successfully.", "readOnly": true, "format": "int64" }, "failedCount": { "readOnly": true, "description": "Output only. The number of entities for which any error was encountered.", "type": "string", "format": "int64" }, "successfulForecastPointCount": { "readOnly": true, "type": "string", "format": "int64", "description": "Output only. The number of the successful forecast points that are generated by the forecasting model. This is ONLY used by the forecasting batch prediction." } }, "id": "GoogleCloudAiplatformV1beta1CompletionStats" }, "GoogleCloudAiplatformV1beta1SummarizationHelpfulnessResult": { "description": "Spec for summarization helpfulness result.", "type": "object", "properties": { "explanation": { "description": "Output only. Explanation for summarization helpfulness score.", "readOnly": true, "type": "string" }, "confidence": { "format": "float", "description": "Output only. Confidence for summarization helpfulness score.", "readOnly": true, "type": "number" }, "score": { "description": "Output only. Summarization Helpfulness score.", "readOnly": true, "type": "number", "format": "float" } }, "id": "GoogleCloudAiplatformV1beta1SummarizationHelpfulnessResult" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoActionRecognition": { "description": "A TrainingJob that trains and uploads an AutoML Video Action Recognition Model.", "type": "object", "properties": { "inputs": { "description": "The input parameters of this TrainingJob.", "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs" } }, "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoActionRecognition" }, "GoogleCloudAiplatformV1beta1BleuResults": { "properties": { "bleuMetricValues": { "items": { "$ref": "GoogleCloudAiplatformV1beta1BleuMetricValue" }, "description": "Output only. Bleu metric values.", "type": "array", "readOnly": true } }, "type": "object", "description": "Results for bleu metric.", "id": "GoogleCloudAiplatformV1beta1BleuResults" }, "GoogleCloudAiplatformV1beta1PipelineJob": { "id": "GoogleCloudAiplatformV1beta1PipelineJob", "type": "object", "description": "An instance of a machine learning PipelineJob.", "properties": { "reservedIpRanges": { "type": "array", "items": { "type": "string" }, "description": "A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']." }, "createTime": { "readOnly": true, "description": "Output only. Pipeline creation time.", "format": "google-datetime", "type": "string" }, "jobDetail": { "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1PipelineJobDetail", "description": "Output only. The details of pipeline run. Not available in the list view." }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "type": "boolean", "readOnly": true }, "network": { "description": "The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.", "type": "string" }, "originalPipelineJobId": { "description": "Optional. The original pipeline job id if this pipeline job is a rerun of a previous pipeline job.", "type": "string", "format": "int64" }, "templateUri": { "type": "string", "description": "A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template." }, "satisfiesPzs": { "readOnly": true, "type": "boolean", "description": "Output only. Reserved for future use." }, "preflightValidations": { "description": "Optional. Whether to do component level validations before job creation.", "type": "boolean" }, "runtimeConfig": { "description": "Runtime config of the pipeline.", "$ref": "GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfig" }, "pscInterfaceConfig": { "$ref": "GoogleCloudAiplatformV1beta1PscInterfaceConfig", "description": "Optional. Configuration for PSC-I for PipelineJob." }, "name": { "readOnly": true, "description": "Output only. The resource name of the PipelineJob.", "type": "string" }, "encryptionSpec": { "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec", "description": "Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key." }, "displayName": { "description": "The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.", "type": "string" }, "error": { "$ref": "GoogleRpcStatus", "description": "Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.", "readOnly": true }, "startTime": { "type": "string", "readOnly": true, "description": "Output only. Pipeline start time.", "format": "google-datetime" }, "serviceAccount": { "description": "The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.", "type": "string" }, "state": { "readOnly": true, "enumDescriptions": [ "The pipeline state is unspecified.", "The pipeline has been created or resumed, and processing has not yet begun.", "The service is preparing to run the pipeline.", "The pipeline is in progress.", "The pipeline completed successfully.", "The pipeline failed.", "The pipeline is being cancelled. From this state, the pipeline may only go to either PIPELINE_STATE_SUCCEEDED, PIPELINE_STATE_FAILED or PIPELINE_STATE_CANCELLED.", "The pipeline has been cancelled.", "The pipeline has been stopped, and can be resumed." ], "enum": [ "PIPELINE_STATE_UNSPECIFIED", "PIPELINE_STATE_QUEUED", "PIPELINE_STATE_PENDING", "PIPELINE_STATE_RUNNING", "PIPELINE_STATE_SUCCEEDED", "PIPELINE_STATE_FAILED", "PIPELINE_STATE_CANCELLING", "PIPELINE_STATE_CANCELLED", "PIPELINE_STATE_PAUSED" ], "description": "Output only. The detailed state of the job.", "type": "string" }, "templateMetadata": { "$ref": "GoogleCloudAiplatformV1beta1PipelineTemplateMetadata", "description": "Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.", "readOnly": true }, "pipelineSpec": { "description": "A compiled definition of a pipeline, represented as a `JSON` object. Defines the structure of the pipeline, including its components, tasks, and parameters. This specification is generated by compiling a pipeline function defined in `Python` using the `Kubeflow Pipelines SDK`.", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "scheduleName": { "type": "string", "description": "Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.", "readOnly": true }, "pipelineTaskRerunConfigs": { "type": "array", "description": "Optional. The rerun configs for each task in the pipeline job. By default, the rerun will: 1. Use the same input artifacts as the original run. 2. Use the same input parameters as the original run. 3. Skip all the tasks that are already succeeded in the original run. 4. Rerun all the tasks that are not succeeded in the original run. By providing this field, users can override the default behavior and specify the rerun config for each task.", "items": { "$ref": "GoogleCloudAiplatformV1beta1PipelineTaskRerunConfig" } }, "endTime": { "description": "Output only. Pipeline end time.", "type": "string", "format": "google-datetime", "readOnly": true }, "labels": { "description": "The labels with user-defined metadata to organize PipelineJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - `vertex-ai-pipelines-run-billing-id`, user set value will get overrided.", "type": "object", "additionalProperties": { "type": "string" } }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when this PipelineJob was most recently updated.", "readOnly": true } } }, "GenaiVertexV1beta1UserInputStep": { "description": "Input provided by the user.", "id": "GenaiVertexV1beta1UserInputStep", "type": "object", "properties": { "contentString": { "type": "string", "description": "The content of the step. A single string." }, "contentList": { "description": "The content of the step. An array of Content objects.", "$ref": "GenaiVertexV1beta1ContentList" } } }, "GoogleCloudAiplatformV1beta1NotebookEucConfig": { "id": "GoogleCloudAiplatformV1beta1NotebookEucConfig", "properties": { "bypassActasCheck": { "readOnly": true, "type": "boolean", "description": "Output only. Whether ActAs check is bypassed for service account attached to the VM. If false, we need ActAs check for the default Compute Engine Service account. When a Runtime is created, a VM is allocated using Default Compute Engine Service Account. Any user requesting to use this Runtime requires Service Account User (ActAs) permission over this SA. If true, Runtime owner is using EUC and does not require the above permission as VM no longer use default Compute Engine SA, but a P4SA." }, "eucDisabled": { "description": "Input only. Whether EUC is disabled in this NotebookRuntimeTemplate. In proto3, the default value of a boolean is false. In this way, by default EUC will be enabled for NotebookRuntimeTemplate.", "type": "boolean" } }, "type": "object", "description": "The euc configuration of NotebookRuntimeTemplate." }, "GoogleIamV1GetPolicyOptions": { "properties": { "requestedPolicyVersion": { "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } }, "type": "object", "description": "Encapsulates settings provided to GetIamPolicy.", "id": "GoogleIamV1GetPolicyOptions" }, "GoogleCloudAiplatformV1beta1MonitoredAgent": { "description": "Represents a monitored agent in a specific Location.", "properties": { "name": { "type": "string", "description": "Identifier. The resource name of the MonitoredAgent." }, "statusMessage": { "type": "string", "description": "Output only. A brief message explaining the current state.", "readOnly": true }, "createTime": { "type": "string", "description": "Output only. The time the MonitoredAgent was created.", "format": "google-datetime", "readOnly": true }, "displayName": { "description": "Optional. The display name of the MonitoredAgent.", "type": "string" }, "agentResource": { "description": "Required. The configuration for the agent being monitored.", "$ref": "GoogleCloudAiplatformV1beta1AgentResource" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time the MonitoredAgent was last updated.", "readOnly": true }, "state": { "enum": [ "ENABLEMENT_STATE_UNSPECIFIED", "ACTIVE", "ENABLING", "DISABLED" ], "readOnly": true, "description": "Output only. The current state of the agent's enablement.", "enumDescriptions": [ "The default value. This value is used if the state is omitted.", "The agent is successfully enabled and active.", "The agent is in the process of being enabled.", "The agent is disabled." ], "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1MonitoredAgent" }, "GenaiVertexV1beta1DynamicAgentConfig": { "type": "object", "properties": { "config": { "$ref": "GenaiVertexV1beta1Struct", "description": "For agents that are not supported statically in the API definition." } }, "id": "GenaiVertexV1beta1DynamicAgentConfig", "description": "Configuration for dynamic agents." }, "GoogleCloudAiplatformV1beta1UploadModelRequest": { "properties": { "modelId": { "type": "string", "description": "Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name. This value may be up to 63 characters, and valid characters are `[a-z0-9_-]`. The first character cannot be a number or hyphen." }, "model": { "$ref": "GoogleCloudAiplatformV1beta1Model", "description": "Required. The Model to create." }, "parentModel": { "description": "Optional. The resource name of the model into which to upload the version. Only specify this field when uploading a new version.", "type": "string" }, "serviceAccount": { "description": "Optional. The user-provided custom service account to use to do the model upload. If empty, [Vertex AI Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) will be used to access resources needed to upload the model. This account must belong to the target project where the model is uploaded to, i.e., the project specified in the `parent` field of this request and have necessary read permissions (to Google Cloud Storage, Artifact Registry, etc.).", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1UploadModelRequest", "type": "object", "description": "Request message for ModelService.UploadModel." }, "GoogleCloudAiplatformV1beta1PublisherModelEulaAcceptance": { "id": "GoogleCloudAiplatformV1beta1PublisherModelEulaAcceptance", "properties": { "publisherModel": { "type": "string", "description": "The publisher model resource name." }, "publisherModelEulaAcked": { "type": "boolean", "description": "The EULA content acceptance status." }, "projectNumber": { "description": "The project number requesting access for named model.", "format": "int64", "type": "string" } }, "description": "Response message for ModelGardenService.UpdatePublisherModelEula.", "type": "object" }, "GoogleCloudAiplatformV1beta1DeployedModelStatus": { "id": "GoogleCloudAiplatformV1beta1DeployedModelStatus", "type": "object", "properties": { "availableReplicaCount": { "description": "Output only. The number of available replicas of the deployed model.", "readOnly": true, "format": "int32", "type": "integer" }, "lastUpdateTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time at which the status was last updated.", "readOnly": true }, "message": { "description": "Output only. The latest deployed model's status message (if any).", "readOnly": true, "type": "string" } }, "description": "Runtime status of the deployed model." }, "GoogleCloudAiplatformV1beta1PurgeExecutionsRequest": { "description": "Request message for MetadataService.PurgeExecutions.", "properties": { "filter": { "description": "Required. A required filter matching the Executions to be purged. E.g., `update_time \u003c= 2020-11-19T11:30:00-04:00`.", "type": "string" }, "force": { "description": "Optional. Flag to indicate to actually perform the purge. If `force` is set to false, the method will return a sample of Execution names that would be deleted.", "type": "boolean" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1PurgeExecutionsRequest" }, "GoogleCloudAiplatformV1beta1GenerateMemoriesRequestVertexSessionSource": { "description": "Defines an Agent Engine Session from which to generate the memories. If `scope` is not provided, the scope will be extracted from the Session (i.e. {\"user_id\": sesison.user_id}).", "properties": { "startTime": { "format": "google-datetime", "description": "Optional. Time range to define which session events should be used to generate memories. Start time (inclusive) of the time range. If not set, the start time is unbounded.", "type": "string" }, "endTime": { "description": "Optional. End time (exclusive) of the time range. If not set, the end time is unbounded.", "format": "google-datetime", "type": "string" }, "session": { "type": "string", "description": "Required. The resource name of the Session to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequestVertexSessionSource" }, "GoogleCloudAiplatformV1beta1ScheduleRunResponse": { "description": "Status of a scheduled run.", "type": "object", "properties": { "scheduledRunTime": { "description": "The scheduled run time based on the user-specified schedule.", "type": "string", "format": "google-datetime" }, "runResponse": { "type": "string", "description": "The response of the scheduled run." } }, "id": "GoogleCloudAiplatformV1beta1ScheduleRunResponse" }, "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigSessionInput": { "id": "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigSessionInput", "type": "object", "properties": { "parameters": { "type": "object", "description": "Optional. Additional parameters for the session, like app_name, etc. For example, {\"app_name\": \"my-app\"}.", "additionalProperties": { "type": "string" } }, "sessionState": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "Optional. Session specific memory which stores key conversation points." }, "userId": { "description": "Optional. The user id for the agent session. The ID can be up to 128 characters long.", "type": "string" } }, "description": "Session input to run an Agent." }, "GoogleCloudAiplatformV1beta1TrajectoryAnyOrderMatchInstance": { "id": "GoogleCloudAiplatformV1beta1TrajectoryAnyOrderMatchInstance", "properties": { "predictedTrajectory": { "description": "Required. Spec for predicted tool call trajectory.", "$ref": "GoogleCloudAiplatformV1beta1Trajectory" }, "referenceTrajectory": { "$ref": "GoogleCloudAiplatformV1beta1Trajectory", "description": "Required. Spec for reference tool call trajectory." } }, "description": "Spec for TrajectoryAnyOrderMatch instance.", "type": "object" }, "GoogleCloudAiplatformV1beta1ResourceRuntimeSpec": { "description": "Configuration for the runtime on a PersistentResource instance, including but not limited to: * Service accounts used to run the workloads. * Whether to make it a dedicated Ray Cluster.", "properties": { "serviceAccountSpec": { "description": "Optional. Configure the use of workload identity on the PersistentResource", "$ref": "GoogleCloudAiplatformV1beta1ServiceAccountSpec" }, "raySpec": { "description": "Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource.", "$ref": "GoogleCloudAiplatformV1beta1RaySpec" } }, "id": "GoogleCloudAiplatformV1beta1ResourceRuntimeSpec", "type": "object" }, "GoogleCloudAiplatformV1beta1Segment": { "type": "object", "properties": { "partIndex": { "description": "Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content.", "format": "int32", "type": "integer", "readOnly": true }, "text": { "readOnly": true, "description": "Output only. The text of the segment.", "type": "string" }, "endIndex": { "type": "integer", "readOnly": true, "description": "Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index.", "format": "int32" }, "startIndex": { "description": "Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment.", "type": "integer", "readOnly": true, "format": "int32" } }, "id": "GoogleCloudAiplatformV1beta1Segment", "description": "A segment of the content." }, "GoogleCloudAiplatformV1beta1IndexDatapointRestriction": { "id": "GoogleCloudAiplatformV1beta1IndexDatapointRestriction", "description": "Restriction of a datapoint which describe its attributes(tokens) from each of several attribute categories(namespaces).", "type": "object", "properties": { "namespace": { "description": "The namespace of this restriction. e.g.: color.", "type": "string" }, "allowList": { "items": { "type": "string" }, "description": "The attributes to allow in this namespace. e.g.: 'red'", "type": "array" }, "denyList": { "description": "The attributes to deny in this namespace. e.g.: 'blue'", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudAiplatformV1beta1ProbeTcpSocketAction": { "id": "GoogleCloudAiplatformV1beta1ProbeTcpSocketAction", "properties": { "port": { "description": "Number of the port to access on the container. Number must be in the range 1 to 65535.", "format": "int32", "type": "integer" }, "host": { "type": "string", "description": "Optional: Host name to connect to, defaults to the model serving container's IP." } }, "type": "object", "description": "TcpSocketAction probes the health of a container by opening a TCP socket connection." }, "GoogleCloudAiplatformV1beta1ModelMonitoringAlertConfig": { "type": "object", "properties": { "emailAlertConfig": { "description": "Email alert config.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringAlertConfigEmailAlertConfig" }, "notificationChannels": { "type": "array", "description": "Resource names of the NotificationChannels to send alert. Must be of the format `projects//notificationChannels/`", "items": { "type": "string" } }, "enableLogging": { "type": "boolean", "description": "Dump the anomalies to Cloud Logging. The anomalies will be put to json payload encoded from proto ModelMonitoringStatsAnomalies. This can be further synced to Pub/Sub or any other services supported by Cloud Logging." } }, "description": "The alert config for model monitoring.", "id": "GoogleCloudAiplatformV1beta1ModelMonitoringAlertConfig" }, "GoogleCloudAiplatformV1beta1ImportDataOperationMetadata": { "properties": { "genericMetadata": { "description": "The common part of the operation metadata.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "description": "Runtime operation information for DatasetService.ImportData.", "type": "object", "id": "GoogleCloudAiplatformV1beta1ImportDataOperationMetadata" }, "GenaiVertexV1beta1McpServerToolResultStep": { "id": "GenaiVertexV1beta1McpServerToolResultStep", "type": "object", "description": "MCPServer tool result step.", "properties": { "serverName": { "type": "string", "description": "The name of the used MCP server." }, "name": { "description": "Name of the tool which is called for this specific tool call.", "type": "string" }, "result": { "$ref": "GenaiVertexV1beta1Value", "description": "Required. The output from the MCP server call. Can be simple text or rich content." } } }, "GoogleCloudAiplatformV1beta1EnterpriseWebSearch": { "type": "object", "description": "Tool to search public web data, powered by Vertex AI Search and Sec4 compliance.", "properties": { "excludeDomains": { "items": { "type": "string" }, "description": "Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.", "type": "array" }, "blockingConfidence": { "description": "Optional. Sites with confidence level chosen & above this value will be blocked from the search results.", "enumDescriptions": [ "Defaults to unspecified.", "Blocks Low and above confidence URL that is risky.", "Blocks Medium and above confidence URL that is risky.", "Blocks High and above confidence URL that is risky.", "Blocks Higher and above confidence URL that is risky.", "Blocks Very high and above confidence URL that is risky.", "Blocks Extremely high confidence URL that is risky." ], "enum": [ "PHISH_BLOCK_THRESHOLD_UNSPECIFIED", "BLOCK_LOW_AND_ABOVE", "BLOCK_MEDIUM_AND_ABOVE", "BLOCK_HIGH_AND_ABOVE", "BLOCK_HIGHER_AND_ABOVE", "BLOCK_VERY_HIGH_AND_ABOVE", "BLOCK_ONLY_EXTREMELY_HIGH" ], "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1EnterpriseWebSearch" }, "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValues": { "type": "object", "description": "A data key and associated feature values to write to the feature view.", "properties": { "features": { "description": "List of features to write.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValuesFeature" } }, "dataKey": { "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDataKey", "description": "The data key." } }, "id": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValues" }, "GoogleCloudAiplatformV1beta1NasJobSpec": { "id": "GoogleCloudAiplatformV1beta1NasJobSpec", "description": "Represents the spec of a NasJob.", "properties": { "resumeNasJobId": { "description": "The ID of the existing NasJob in the same Project and Location which will be used to resume search. search_space_spec and nas_algorithm_spec are obtained from previous NasJob hence should not provide them again for this NasJob.", "type": "string" }, "multiTrialAlgorithmSpec": { "description": "The spec of multi-trial algorithms.", "$ref": "GoogleCloudAiplatformV1beta1NasJobSpecMultiTrialAlgorithmSpec" }, "searchSpaceSpec": { "description": "It defines the search space for Neural Architecture Search (NAS).", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1UndeployModelResponse": { "type": "object", "description": "Response message for EndpointService.UndeployModel.", "properties": {}, "id": "GoogleCloudAiplatformV1beta1UndeployModelResponse" }, "GoogleCloudAiplatformV1beta1GenerateFetchAccessTokenRequest": { "type": "object", "description": "Request message for FeatureOnlineStoreService.GenerateFetchAccessToken.", "properties": {}, "id": "GoogleCloudAiplatformV1beta1GenerateFetchAccessTokenRequest" }, "GoogleCloudAiplatformV1beta1SchemaPromptSpecTranslationFileInputSource": { "id": "GoogleCloudAiplatformV1beta1SchemaPromptSpecTranslationFileInputSource", "type": "object", "properties": { "content": { "type": "string", "description": "The file's contents." }, "mimeType": { "description": "The file's mime type.", "type": "string" }, "displayName": { "type": "string", "description": "The file's display name." } } }, "GoogleCloudAiplatformV1beta1PairwiseSummarizationQualityInstance": { "id": "GoogleCloudAiplatformV1beta1PairwiseSummarizationQualityInstance", "properties": { "instruction": { "type": "string", "description": "Required. Summarization prompt for LLM." }, "prediction": { "description": "Required. Output of the candidate model.", "type": "string" }, "baselinePrediction": { "type": "string", "description": "Required. Output of the baseline model." }, "context": { "type": "string", "description": "Required. Text to be summarized." }, "reference": { "description": "Optional. Ground truth used to compare against the prediction.", "type": "string" } }, "description": "Spec for pairwise summarization quality instance.", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaImageBoundingBoxAnnotation": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaImageBoundingBoxAnnotation", "properties": { "yMin": { "format": "double", "type": "number", "description": "The topmost coordinate of the bounding box." }, "annotationSpecId": { "description": "The resource Id of the AnnotationSpec that this Annotation pertains to.", "type": "string" }, "yMax": { "type": "number", "description": "The bottommost coordinate of the bounding box.", "format": "double" }, "displayName": { "description": "The display name of the AnnotationSpec that this Annotation pertains to.", "type": "string" }, "xMin": { "type": "number", "description": "The leftmost coordinate of the bounding box.", "format": "double" }, "xMax": { "type": "number", "description": "The rightmost coordinate of the bounding box.", "format": "double" } }, "description": "Annotation details specific to image object detection." }, "GoogleCloudAiplatformV1beta1CoherenceInput": { "properties": { "instance": { "description": "Required. Coherence instance.", "$ref": "GoogleCloudAiplatformV1beta1CoherenceInstance" }, "metricSpec": { "description": "Required. Spec for coherence score metric.", "$ref": "GoogleCloudAiplatformV1beta1CoherenceSpec" } }, "id": "GoogleCloudAiplatformV1beta1CoherenceInput", "description": "Input for coherence metric.", "type": "object" }, "GenaiVertexV1beta1FunctionCallDelta": { "id": "GenaiVertexV1beta1FunctionCallDelta", "properties": { "name": { "type": "string" }, "arguments": { "$ref": "GenaiVertexV1beta1Struct" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec": { "type": "object", "properties": { "trialJobSpec": { "$ref": "GoogleCloudAiplatformV1beta1CustomJobSpec", "description": "The spec of a trial job. The same spec applies to the CustomJobs created in all the trials." }, "maxFailedTrialCount": { "description": "The number of failed Trials that need to be seen before failing the HyperparameterTuningJob. If set to 0, Vertex AI decides how many Trials must fail before the whole job fails.", "format": "int32", "type": "integer" }, "maxTrialCount": { "type": "integer", "format": "int32", "description": "The desired total number of Trials." }, "studySpec": { "description": "Study configuration of the HyperparameterTuningJob.", "$ref": "GoogleCloudAiplatformV1beta1StudySpec" }, "parallelTrialCount": { "description": "The desired number of Trials to run in parallel.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionHyperparameterTuningJobSpec" }, "GoogleCloudAiplatformV1beta1ContentsExampleExpectedContent": { "properties": { "content": { "$ref": "GoogleCloudAiplatformV1beta1Content", "description": "Required. A single step's content." } }, "id": "GoogleCloudAiplatformV1beta1ContentsExampleExpectedContent", "description": "A single step of the expected output.", "type": "object" }, "GenaiVertexV1beta1StepList": { "type": "object", "id": "GenaiVertexV1beta1StepList", "description": "A list of Steps.", "properties": { "steps": { "type": "array", "description": "The steps of the list.", "items": { "$ref": "GenaiVertexV1beta1Step" } } } }, "GoogleCloudAiplatformV1beta1FeatureViewVertexRagSource": { "properties": { "ragCorpusId": { "type": "string", "description": "Optional. The RAG corpus id corresponding to this FeatureView.", "format": "int64" }, "uri": { "description": "Required. The BigQuery view/table URI that will be materialized on each manual sync trigger. The table/view is expected to have the following columns and types at least: - `corpus_id` (STRING, NULLABLE/REQUIRED) - `file_id` (STRING, NULLABLE/REQUIRED) - `chunk_id` (STRING, NULLABLE/REQUIRED) - `chunk_data_type` (STRING, NULLABLE/REQUIRED) - `chunk_data` (STRING, NULLABLE/REQUIRED) - `embeddings` (FLOAT, REPEATED) - `file_original_uri` (STRING, NULLABLE/REQUIRED)", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1FeatureViewVertexRagSource", "type": "object", "description": "A Vertex Rag source for features that need to be synced to Online Store." }, "GoogleCloudAiplatformV1beta1SuggestTrialsRequest": { "id": "GoogleCloudAiplatformV1beta1SuggestTrialsRequest", "type": "object", "properties": { "clientId": { "type": "string", "description": "Required. The identifier of the client that is requesting the suggestion. If multiple SuggestTrialsRequests have the same `client_id`, the service will return the identical suggested Trial if the Trial is pending, and provide a new Trial if the last suggested Trial was completed." }, "suggestionCount": { "type": "integer", "format": "int32", "description": "Required. The number of suggestions requested. It must be positive." }, "contexts": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1TrialContext" }, "description": "Optional. This allows you to specify the \"context\" for a Trial; a context is a slice (a subspace) of the search space. Typical uses for contexts: 1) You are using Vizier to tune a server for best performance, but there's a strong weekly cycle. The context specifies the day-of-week. This allows Tuesday to generalize from Wednesday without assuming that everything is identical. 2) Imagine you're optimizing some medical treatment for people. As they walk in the door, you know certain facts about them (e.g. sex, weight, height, blood-pressure). Put that information in the context, and Vizier will adapt its suggestions to the patient. 3) You want to do a fair A/B test efficiently. Specify the \"A\" and \"B\" conditions as contexts, and Vizier will generalize between \"A\" and \"B\" conditions. If they are similar, this will allow Vizier to converge to the optimum faster than if \"A\" and \"B\" were separate Studies. NOTE: You can also enter contexts as REQUESTED Trials, e.g. via the CreateTrial() RPC; that's the asynchronous option where you don't need a close association between contexts and suggestions. NOTE: All the Parameters you set in a context MUST be defined in the Study. NOTE: You must supply 0 or $suggestion_count contexts. If you don't supply any contexts, Vizier will make suggestions from the full search space specified in the StudySpec; if you supply a full set of context, each suggestion will match the corresponding context. NOTE: A Context with no features set matches anything, and allows suggestions from the full search space. NOTE: Contexts MUST lie within the search space specified in the StudySpec. It's an error if they don't. NOTE: Contexts preferentially match ACTIVE then REQUESTED trials before new suggestions are generated. NOTE: Generation of suggestions involves a match between a Context and (optionally) a REQUESTED trial; if that match is not fully specified, a suggestion will be geneated in the merged subspace." } }, "description": "Request message for VizierService.SuggestTrials." }, "GoogleCloudAiplatformV1beta1SearchMigratableResourcesRequest": { "description": "Request message for MigrationService.SearchMigratableResources.", "properties": { "filter": { "type": "string", "description": "A filter for your search. You can use the following types of filters: * Resource type filters. The following strings filter for a specific type of MigratableResource: * `ml_engine_model_version:*` * `automl_model:*` * `automl_dataset:*` * `data_labeling_dataset:*` * \"Migrated or not\" filters. The following strings filter for resources that either have or have not already been migrated: * `last_migrate_time:*` filters for migrated resources. * `NOT last_migrate_time:*` filters for not yet migrated resources." }, "pageSize": { "format": "int32", "type": "integer", "description": "The standard page size. The default and maximum value is 100." }, "pageToken": { "description": "The standard page token.", "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SearchMigratableResourcesRequest" }, "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig": { "description": "The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name.", "properties": { "autoMode": { "description": "In this mode, the model is selected automatically based on the content of the request.", "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode" }, "manualMode": { "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode", "description": "In this mode, the model is specified manually." } }, "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig", "type": "object" }, "GoogleCloudAiplatformV1beta1RagCorpusCorpusTypeConfig": { "type": "object", "description": "The config for the corpus type of the RagCorpus.", "id": "GoogleCloudAiplatformV1beta1RagCorpusCorpusTypeConfig", "properties": { "documentCorpus": { "$ref": "GoogleCloudAiplatformV1beta1RagCorpusCorpusTypeConfigDocumentCorpus", "description": "Optional. Config for the document corpus." }, "memoryCorpus": { "$ref": "GoogleCloudAiplatformV1beta1RagCorpusCorpusTypeConfigMemoryCorpus", "description": "Optional. Config for the memory corpus." } } }, "GoogleTypeMoney": { "type": "object", "description": "Represents an amount of money with its currency type.", "id": "GoogleTypeMoney", "properties": { "units": { "type": "string", "format": "int64", "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar." }, "nanos": { "description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", "format": "int32", "type": "integer" }, "currencyCode": { "type": "string", "description": "The three-letter currency code defined in ISO 4217." } } }, "GoogleCloudAiplatformV1beta1DataItem": { "type": "object", "description": "A piece of data in a Dataset. Could be an image, a video, a document or plain text.", "properties": { "etag": { "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "type": "string" }, "satisfiesPzi": { "type": "boolean", "description": "Output only. Reserved for future use.", "readOnly": true }, "payload": { "type": "any", "description": "Required. The data that the DataItem represents (for example, an image or a text snippet). The schema of the payload is stored in the parent Dataset's metadata schema's dataItemSchemaUri field." }, "satisfiesPzs": { "type": "boolean", "readOnly": true, "description": "Output only. Reserved for future use." }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. The labels with user-defined metadata to organize your DataItems. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one DataItem(System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable." }, "updateTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. Timestamp when this DataItem was last updated." }, "name": { "readOnly": true, "description": "Output only. The resource name of the DataItem.", "type": "string" }, "createTime": { "type": "string", "description": "Output only. Timestamp when this DataItem was created.", "readOnly": true, "format": "google-datetime" } }, "id": "GoogleCloudAiplatformV1beta1DataItem" }, "GoogleCloudAiplatformV1beta1CancelBatchPredictionJobRequest": { "id": "GoogleCloudAiplatformV1beta1CancelBatchPredictionJobRequest", "properties": {}, "type": "object", "description": "Request message for JobService.CancelBatchPredictionJob." }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoObjectTracking": { "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoObjectTracking", "properties": { "inputs": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs", "description": "The input parameters of this TrainingJob." } }, "description": "A TrainingJob that trains and uploads an AutoML Video ObjectTracking Model.", "type": "object" }, "GoogleCloudAiplatformV1beta1CreateFeatureGroupOperationMetadata": { "description": "Details of operations that perform create FeatureGroup.", "properties": { "genericMetadata": { "description": "Operation metadata for FeatureGroup.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "id": "GoogleCloudAiplatformV1beta1CreateFeatureGroupOperationMetadata", "type": "object" }, "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigPromptTemplate": { "type": "object", "properties": { "gcsUri": { "type": "string", "description": "Prompt template stored in Cloud Storage. Format: \"gs://my-bucket/file-name.txt\"." }, "promptTemplate": { "description": "Inline prompt template. Template variables should be in the format \"{var_name}\". Example: \"Translate the following from {source_lang} to {target_lang}: {text}\"", "type": "string" } }, "description": "Prompt template used for inference.", "id": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigPromptTemplate" }, "GoogleCloudAiplatformV1beta1AnalyzedInvocation": { "id": "GoogleCloudAiplatformV1beta1AnalyzedInvocation", "description": "Represents an analyzed invocation for a monitored agent's session.", "type": "object", "properties": { "invocationId": { "readOnly": true, "description": "Output only. The invocation ID.", "type": "string" }, "name": { "type": "string", "description": "Identifier. The resource name of the AnalyzedInvocation." }, "assessment": { "$ref": "GoogleCloudAiplatformV1beta1Assessment", "readOnly": true, "description": "Output only. The assessment of the invocation." }, "invocationState": { "description": "Output only. The state of the invocation.", "type": "string", "enumDescriptions": [ "Unspecified state.", "The invocation is anomalous.", "The invocation is not anomalous." ], "readOnly": true, "enum": [ "INVOCATION_STATE_UNSPECIFIED", "INVOCATION_STATE_ANOMALOUS", "INVOCATION_STATE_NOT_ANOMALOUS" ] } } }, "GoogleCloudAiplatformV1beta1SearchFeaturesResponse": { "description": "Response message for FeaturestoreService.SearchFeatures.", "id": "GoogleCloudAiplatformV1beta1SearchFeaturesResponse", "type": "object", "properties": { "features": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Feature" }, "type": "array", "description": "The Features matching the request. Fields returned: * `name` * `description` * `labels` * `create_time` * `update_time`" }, "nextPageToken": { "type": "string", "description": "A token, which can be sent as SearchFeaturesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages." } } }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation": { "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation", "description": "Treats the column as categorical array and performs following transformation functions. * For each element in the array, convert the category name to a dictionary lookup index and generate an embedding for each index. Combine the embedding of all elements into a single embedding using the mean. * Empty arrays treated as an embedding of zeroes.", "type": "object", "properties": { "columnName": { "type": "string" } } }, "GoogleCloudAiplatformV1beta1BigQueryRequestSet": { "properties": { "promptColumn": { "description": "Optional. The name of the column that contains the requests to evaluate. This will be in evaluation_item.EvalPrompt format.", "type": "string" }, "uri": { "description": "Required. The URI of a BigQuery table. e.g. bq://projectId.bqDatasetId.bqTableId", "type": "string" }, "rubricsColumn": { "description": "Optional. The name of the column that contains the rubrics. This is in evaluation_rubric.RubricGroup format.", "type": "string" }, "samplingConfig": { "description": "Optional. The sampling config for the bigquery resource.", "$ref": "GoogleCloudAiplatformV1beta1BigQueryRequestSetSamplingConfig" }, "candidateResponseColumns": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. Map of candidate name to candidate response column name. The column will be in evaluation_item.CandidateResponse format." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1BigQueryRequestSet", "description": "The request set for the evaluation run." }, "GoogleCloudAiplatformV1beta1RagVectorDbConfig": { "description": "Config for the Vector DB to use for RAG.", "id": "GoogleCloudAiplatformV1beta1RagVectorDbConfig", "properties": { "apiAuth": { "description": "Authentication config for the chosen Vector DB.", "$ref": "GoogleCloudAiplatformV1beta1ApiAuth" }, "ragManagedDb": { "$ref": "GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDb", "description": "The config for the RAG-managed Vector DB." }, "ragEmbeddingModelConfig": { "$ref": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfig", "description": "Optional. Immutable. The embedding model config of the Vector DB." }, "weaviate": { "description": "The config for the Weaviate.", "$ref": "GoogleCloudAiplatformV1beta1RagVectorDbConfigWeaviate" }, "pinecone": { "$ref": "GoogleCloudAiplatformV1beta1RagVectorDbConfigPinecone", "description": "The config for the Pinecone." }, "ragManagedVertexVectorSearch": { "description": "The config for the RAG-managed Vertex Vector Search 2.0.", "$ref": "GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedVertexVectorSearch" }, "vertexFeatureStore": { "$ref": "GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexFeatureStore", "description": "The config for the Vertex Feature Store." }, "vertexVectorSearch": { "description": "The config for the Vertex Vector Search.", "$ref": "GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexVectorSearch" } }, "type": "object" }, "GenaiVertexV1beta1McpServerToolCallDelta": { "properties": { "arguments": { "$ref": "GenaiVertexV1beta1Struct" }, "name": { "type": "string" }, "serverName": { "type": "string" } }, "type": "object", "id": "GenaiVertexV1beta1McpServerToolCallDelta" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformation", "properties": { "numeric": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationNumericTransformation" }, "text": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTextTransformation" }, "timestamp": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationTimestampTransformation" }, "categorical": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationCategoricalTransformation" }, "auto": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingInputsTransformationAutoTransformation" } } }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation": { "properties": { "timeFormat": { "description": "The format in which that time field is expressed. The time_format must either be one of: * `unix-seconds` * `unix-milliseconds` * `unix-microseconds` * `unix-nanoseconds` (for respectively number of seconds, milliseconds, microseconds and nanoseconds since start of the Unix epoch); or be written in `strftime` syntax. If time_format is not set, then the default format is RFC 3339 `date-time` format, where `time-offset` = `\"Z\"` (e.g. 1985-04-12T23:20:50.52Z)", "type": "string" }, "invalidValuesAllowed": { "description": "If invalid values is allowed, the training pipeline will create a boolean feature that indicated whether the value is valid. Otherwise, the training pipeline will discard the input row from trainining data.", "type": "boolean" }, "columnName": { "type": "string" } }, "type": "object", "description": "Training pipeline will perform following transformation functions. * Apply the transformation functions for Numerical columns. * Determine the year, month, day,and weekday. Treat each value from the * timestamp as a Categorical column. * Invalid numerical values (for example, values that fall outside of a typical timestamp range, or are extreme values) receive no special treatment and are not removed.", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation" }, "GoogleCloudAiplatformV1beta1SmoothGradConfig": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SmoothGradConfig", "description": "Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf", "properties": { "featureNoiseSigma": { "description": "This is similar to noise_sigma, but provides additional flexibility. A separate noise sigma can be provided for each feature, which is useful if their distributions are different. No noise is added to features that are not set. If this field is unset, noise_sigma will be used for all features.", "$ref": "GoogleCloudAiplatformV1beta1FeatureNoiseSigma" }, "noisySampleCount": { "format": "int32", "description": "The number of gradient samples to use for approximation. The higher this number, the more accurate the gradient is, but the runtime complexity increases by this factor as well. Valid range of its value is [1, 50]. Defaults to 3.", "type": "integer" }, "noiseSigma": { "format": "float", "description": "This is a single float value and will be used to add noise to all the features. Use this field when all features are normalized to have the same distribution: scale to range [0, 1], [-1, 1] or z-scoring, where features are normalized to have 0-mean and 1-variance. Learn more about [normalization](https://developers.google.com/machine-learning/data-prep/transform/normalization). For best results the recommended value is about 10% - 20% of the standard deviation of the input feature. Refer to section 3.2 of the SmoothGrad paper: https://arxiv.org/pdf/1706.03825.pdf. Defaults to 0.1. If the distribution is different per feature, set feature_noise_sigma instead for each feature.", "type": "number" } } }, "GoogleCloudAiplatformV1beta1EvaluatedAnnotation": { "id": "GoogleCloudAiplatformV1beta1EvaluatedAnnotation", "description": "True positive, false positive, or false negative. EvaluatedAnnotation is only available under ModelEvaluationSlice with slice of `annotationSpec` dimension.", "type": "object", "properties": { "type": { "description": "Output only. Type of the EvaluatedAnnotation.", "type": "string", "enum": [ "EVALUATED_ANNOTATION_TYPE_UNSPECIFIED", "TRUE_POSITIVE", "FALSE_POSITIVE", "FALSE_NEGATIVE" ], "readOnly": true, "enumDescriptions": [ "Invalid value.", "The EvaluatedAnnotation is a true positive. It has a prediction created by the Model and a ground truth Annotation which the prediction matches.", "The EvaluatedAnnotation is false positive. It has a prediction created by the Model which does not match any ground truth annotation.", "The EvaluatedAnnotation is false negative. It has a ground truth annotation which is not matched by any of the model created predictions." ] }, "dataItemPayload": { "type": "any", "readOnly": true, "description": "Output only. The data item payload that the Model predicted this EvaluatedAnnotation on." }, "errorAnalysisAnnotations": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1ErrorAnalysisAnnotation" }, "description": "Annotations of model error analysis results." }, "groundTruths": { "type": "array", "readOnly": true, "description": "Output only. The ground truth Annotations, i.e. the Annotations that exist in the test data the Model is evaluated on. For true positive, there is one and only one ground truth annotation, which matches the only prediction in predictions. For false positive, there are zero or more ground truth annotations that are similar to the only prediction in predictions, but not enough for a match. For false negative, there is one and only one ground truth annotation, which doesn't match any predictions created by the model. The schema of the ground truth is stored in ModelEvaluation.annotation_schema_uri", "items": { "type": "any" } }, "predictions": { "readOnly": true, "description": "Output only. The model predicted annotations. For true positive, there is one and only one prediction, which matches the only one ground truth annotation in ground_truths. For false positive, there is one and only one prediction, which doesn't match any ground truth annotation of the corresponding data_item_view_id. For false negative, there are zero or more predictions which are similar to the only ground truth annotation in ground_truths but not enough for a match. The schema of the prediction is stored in ModelEvaluation.annotation_schema_uri", "items": { "type": "any" }, "type": "array" }, "explanations": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1EvaluatedAnnotationExplanation" }, "description": "Explanations of predictions. Each element of the explanations indicates the explanation for one explanation Method. The attributions list in the EvaluatedAnnotationExplanation.explanation object corresponds to the predictions list. For example, the second element in the attributions list explains the second element in the predictions list." }, "evaluatedDataItemViewId": { "readOnly": true, "type": "string", "description": "Output only. ID of the EvaluatedDataItemView under the same ancestor ModelEvaluation. The EvaluatedDataItemView consists of all ground truths and predictions on data_item_payload." } } }, "GoogleCloudAiplatformV1beta1SearchExamplesResponseSimilarExample": { "id": "GoogleCloudAiplatformV1beta1SearchExamplesResponseSimilarExample", "description": "The result of the similar example.", "properties": { "example": { "$ref": "GoogleCloudAiplatformV1beta1Example", "description": "The example that is similar to the searched query." }, "similarityScore": { "type": "number", "description": "The similarity score of this example.", "format": "float" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1PipelineTemplateMetadata": { "properties": { "version": { "description": "The version_name in artifact registry. Will always be presented in output if the PipelineJob.template_uri is from supported template registry. Format is \"sha256:abcdef123456...\".", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1PipelineTemplateMetadata", "type": "object", "description": "Pipeline template metadata if PipelineJob.template_uri is from supported template registry. Currently, the only supported registry is Artifact Registry." }, "GoogleCloudAiplatformV1beta1CreateFeatureOperationMetadata": { "description": "Details of operations that perform create Feature.", "type": "object", "id": "GoogleCloudAiplatformV1beta1CreateFeatureOperationMetadata", "properties": { "genericMetadata": { "description": "Operation metadata for Feature.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } } }, "GoogleCloudAiplatformV1beta1FeatureGroup": { "properties": { "name": { "type": "string", "description": "Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`" }, "serviceAgentType": { "type": "string", "enum": [ "SERVICE_AGENT_TYPE_UNSPECIFIED", "SERVICE_AGENT_TYPE_PROJECT", "SERVICE_AGENT_TYPE_FEATURE_GROUP" ], "enumDescriptions": [ "By default, the project-level Vertex AI Service Agent is enabled.", "Specifies the project-level Vertex AI Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).", "Enable a FeatureGroup service account to be created by Vertex AI and output in the field `service_account_email`. This service account will be used to read from the source BigQuery table during jobs under a FeatureGroup." ], "description": "Optional. Service agent type used during jobs under a FeatureGroup. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureGroup within a project, a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_GROUP`. This will generate a separate service account to access the BigQuery source table." }, "updateTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. Timestamp when this FeatureGroup was last updated." }, "bigQuery": { "description": "Indicates that features for this group come from BigQuery Table/View. By default treats the source as a sparse time series source. The BigQuery source table or view must have at least one entity ID column and a column named `feature_timestamp`.", "$ref": "GoogleCloudAiplatformV1beta1FeatureGroupBigQuery" }, "etag": { "type": "string", "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens." }, "labels": { "description": "Optional. The labels with user-defined metadata to organize your FeatureGroup. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureGroup(System labels are excluded).\" System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable.", "type": "object", "additionalProperties": { "type": "string" } }, "description": { "description": "Optional. Description of the FeatureGroup.", "type": "string" }, "createTime": { "type": "string", "readOnly": true, "description": "Output only. Timestamp when this FeatureGroup was created.", "format": "google-datetime" }, "serviceAccountEmail": { "description": "Output only. A Service Account unique to this FeatureGroup. The role bigquery.dataViewer should be granted to this service account to allow Vertex AI Feature Store to access source data while running jobs under this FeatureGroup.", "type": "string", "readOnly": true } }, "description": "Vertex AI Feature Group.", "type": "object", "id": "GoogleCloudAiplatformV1beta1FeatureGroup" }, "GoogleCloudAiplatformV1beta1PredictSchemata": { "type": "object", "properties": { "predictionSchemaUri": { "type": "string", "description": "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." }, "instanceSchemaUri": { "type": "string", "description": "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": { "description": "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.", "type": "string" } }, "description": "Contains the schemata used in Model's predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob.", "id": "GoogleCloudAiplatformV1beta1PredictSchemata" }, "GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecDraftModelSpeculation": { "type": "object", "properties": { "draftModel": { "description": "Required. The resource name of the draft model.", "type": "string" } }, "description": "Draft model speculation works by using the smaller model to generate candidate tokens for speculative decoding.", "id": "GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecDraftModelSpeculation" }, "GoogleCloudAiplatformV1beta1CometSpec": { "properties": { "targetLanguage": { "description": "Optional. Target language in BCP-47 format. Covers both prediction and reference.", "type": "string" }, "version": { "description": "Required. Which version to use for evaluation.", "enumDescriptions": [ "Comet version unspecified.", "Comet 22 for translation + source + reference (source-reference-combined)." ], "type": "string", "enum": [ "COMET_VERSION_UNSPECIFIED", "COMET_22_SRC_REF" ] }, "sourceLanguage": { "description": "Optional. Source language in BCP-47 format.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1CometSpec", "description": "Spec for Comet metric.", "type": "object" }, "GoogleCloudAiplatformV1beta1ModelMonitoringInputVertexEndpointLogs": { "description": "Data from Vertex AI Endpoint request response logging.", "type": "object", "id": "GoogleCloudAiplatformV1beta1ModelMonitoringInputVertexEndpointLogs", "properties": { "endpoints": { "type": "array", "items": { "type": "string" }, "description": "List of endpoint resource names. The endpoints must enable the logging with the [Endpoint].[request_response_logging_config], and must contain the deployed model corresponding to the model version specified in [ModelMonitor].[model_monitoring_target]." } } }, "GoogleCloudAiplatformV1beta1FileData": { "description": "URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage.", "properties": { "displayName": { "type": "string", "description": "Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled." }, "fileUri": { "type": "string", "description": "Required. The URI of the file in Google Cloud Storage." }, "mimeType": { "description": "Required. The IANA standard MIME type of the source data.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1FileData", "type": "object" }, "GoogleCloudAiplatformV1beta1SearchModelDeploymentMonitoringStatsAnomaliesRequest": { "type": "object", "properties": { "startTime": { "type": "string", "description": "The earliest timestamp of stats being generated. If not set, indicates fetching stats till the earliest possible one.", "format": "google-datetime" }, "pageSize": { "format": "int32", "description": "The standard list page size.", "type": "integer" }, "pageToken": { "description": "A page token received from a previous JobService.SearchModelDeploymentMonitoringStatsAnomalies call.", "type": "string" }, "endTime": { "format": "google-datetime", "description": "The latest timestamp of stats being generated. If not set, indicates feching stats till the latest possible one.", "type": "string" }, "featureDisplayName": { "description": "The feature display name. If specified, only return the stats belonging to this feature. Format: ModelMonitoringStatsAnomalies.FeatureHistoricStatsAnomalies.feature_display_name, example: \"user_destination\".", "type": "string" }, "deployedModelId": { "description": "Required. The DeployedModel ID of the [ModelDeploymentMonitoringObjectiveConfig.deployed_model_id].", "type": "string" }, "objectives": { "type": "array", "description": "Required. Objectives of the stats to retrieve.", "items": { "$ref": "GoogleCloudAiplatformV1beta1SearchModelDeploymentMonitoringStatsAnomaliesRequestStatsAnomaliesObjective" } } }, "id": "GoogleCloudAiplatformV1beta1SearchModelDeploymentMonitoringStatsAnomaliesRequest", "description": "Request message for JobService.SearchModelDeploymentMonitoringStatsAnomalies." }, "GoogleCloudAiplatformV1beta1QuestionAnsweringQualityInstance": { "id": "GoogleCloudAiplatformV1beta1QuestionAnsweringQualityInstance", "properties": { "context": { "description": "Required. Text to answer the question.", "type": "string" }, "reference": { "description": "Optional. Ground truth used to compare against the prediction.", "type": "string" }, "instruction": { "description": "Required. Question Answering prompt for LLM.", "type": "string" }, "prediction": { "description": "Required. Output of the evaluated model.", "type": "string" } }, "type": "object", "description": "Spec for question answering quality instance." }, "GoogleCloudAiplatformV1beta1FeatureValueList": { "description": "Container for list of values.", "id": "GoogleCloudAiplatformV1beta1FeatureValueList", "properties": { "values": { "description": "A list of feature values. All of them should be the same data type.", "items": { "$ref": "GoogleCloudAiplatformV1beta1FeatureValue" }, "type": "array" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1A2aTaskHistoryAppend": { "properties": { "message": { "description": "Required. The message to append to the task history.", "$ref": "GoogleCloudAiplatformV1beta1A2aTaskMessage" } }, "id": "GoogleCloudAiplatformV1beta1A2aTaskHistoryAppend", "description": "An event payload that appends a new message to the task history.", "type": "object" }, "GoogleCloudAiplatformV1beta1FetchExamplesRequest": { "properties": { "exampleIds": { "items": { "type": "string" }, "type": "array", "description": "Optional. Example IDs to fetch. If both metadata filters and Example IDs are specified, then both ID and metadata filtering will be applied." }, "storedContentsExampleFilter": { "$ref": "GoogleCloudAiplatformV1beta1StoredContentsExampleFilter", "description": "The metadata filters for StoredContentsExamples." }, "pageSize": { "description": "Optional. The maximum number of examples to return. The service may return fewer than this value. If unspecified, at most 100 examples will be returned.", "type": "integer", "format": "int32" }, "pageToken": { "type": "string", "description": "Optional. The next_page_token value returned from a previous list ExampleStoreService.FetchExamplesResponse call." } }, "id": "GoogleCloudAiplatformV1beta1FetchExamplesRequest", "description": "Request message for ExampleStoreService.FetchExamples.", "type": "object" }, "GoogleCloudLocationListLocationsResponse": { "type": "object", "properties": { "locations": { "items": { "$ref": "GoogleCloudLocationLocation" }, "type": "array", "description": "A list of locations that matches the specified filter in the request." }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } }, "description": "The response message for Locations.ListLocations.", "id": "GoogleCloudLocationListLocationsResponse" }, "GoogleCloudAiplatformV1beta1RollbackMemoryRequest": { "description": "Request message for MemoryBankService.RollbackMemory.", "type": "object", "id": "GoogleCloudAiplatformV1beta1RollbackMemoryRequest", "properties": { "targetRevisionId": { "type": "string", "format": "int64", "description": "Required. The ID of the revision to rollback to." } } }, "GoogleCloudAiplatformV1beta1SupervisedTuningDatasetDistribution": { "type": "object", "properties": { "sum": { "readOnly": true, "description": "Output only. Sum of a given population of values.", "type": "string", "format": "int64" }, "median": { "description": "Output only. The median of the values in the population.", "type": "number", "readOnly": true, "format": "double" }, "max": { "readOnly": true, "format": "double", "type": "number", "description": "Output only. The maximum of the population values." }, "billableSum": { "type": "string", "description": "Output only. Sum of a given population of values that are billable.", "format": "int64", "readOnly": true }, "min": { "description": "Output only. The minimum of the population values.", "type": "number", "readOnly": true, "format": "double" }, "p95": { "format": "double", "type": "number", "readOnly": true, "description": "Output only. The 95th percentile of the values in the population." }, "p5": { "format": "double", "readOnly": true, "type": "number", "description": "Output only. The 5th percentile of the values in the population." }, "mean": { "description": "Output only. The arithmetic mean of the values in the population.", "readOnly": true, "type": "number", "format": "double" }, "buckets": { "items": { "$ref": "GoogleCloudAiplatformV1beta1SupervisedTuningDatasetDistributionDatasetBucket" }, "type": "array", "readOnly": true, "description": "Output only. Defines the histogram bucket." } }, "id": "GoogleCloudAiplatformV1beta1SupervisedTuningDatasetDistribution", "description": "Dataset distribution for Supervised Tuning." }, "GoogleCloudAiplatformV1beta1PublisherModelCallToAction": { "description": "Actions could take on this Publisher Model.", "type": "object", "id": "GoogleCloudAiplatformV1beta1PublisherModelCallToAction", "properties": { "openNotebook": { "description": "Optional. Open notebook of the PublisherModel.", "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences" }, "deploy": { "description": "Optional. Deploy the PublisherModel to Vertex Endpoint.", "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeploy" }, "deployGke": { "description": "Optional. Deploy PublisherModel to Google Kubernetes Engine.", "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployGke" }, "openFineTuningPipelines": { "description": "Optional. Open fine-tuning pipelines of the PublisherModel.", "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionOpenFineTuningPipelines" }, "createApplication": { "description": "Optional. Create application using the PublisherModel.", "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences" }, "viewRestApi": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionViewRestApi", "description": "Optional. To view Rest API docs." }, "openPromptTuningPipeline": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences", "description": "Optional. Open prompt-tuning pipeline of the PublisherModel." }, "openGenerationAiStudio": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences", "description": "Optional. Open in Generation AI Studio." }, "openFineTuningPipeline": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences", "description": "Optional. Open fine-tuning pipeline of the PublisherModel." }, "multiDeployVertex": { "description": "Optional. Multiple setups to deploy the PublisherModel to Vertex Endpoint.", "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployVertex" }, "openGenie": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences", "description": "Optional. Open Genie / Playground." }, "openEvaluationPipeline": { "description": "Optional. Open evaluation pipeline of the PublisherModel.", "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences" }, "requestAccess": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences", "description": "Optional. Request for access." }, "openNotebooks": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionOpenNotebooks", "description": "Optional. Open notebooks of the PublisherModel." } } }, "GoogleCloudAiplatformV1beta1Scalar": { "id": "GoogleCloudAiplatformV1beta1Scalar", "description": "One point viewable on a scalar metric plot.", "properties": { "value": { "description": "Value of the point at this step / timestamp.", "format": "double", "type": "number" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1FluencySpec": { "description": "Spec for fluency score metric.", "type": "object", "properties": { "version": { "format": "int32", "type": "integer", "description": "Optional. Which version to use for evaluation." } }, "id": "GoogleCloudAiplatformV1beta1FluencySpec" }, "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics": { "type": "object", "description": "Metrics for general pairwise text generation evaluation results.", "properties": { "precision": { "description": "Fraction of cases where the autorater and humans thought the model had a better response out of all cases where the autorater thought the model had a better response. True positive divided by all positive.", "format": "float", "type": "number" }, "recall": { "type": "number", "format": "float", "description": "Fraction of cases where the autorater and humans thought the model had a better response out of all cases where the humans thought the model had a better response." }, "humanPreferenceModelWinRate": { "type": "number", "description": "Percentage of time humans decided the model had the better response.", "format": "float" }, "falsePositiveCount": { "description": "Number of examples where the autorater chose the model, but humans preferred the baseline model.", "type": "string", "format": "int64" }, "accuracy": { "type": "number", "description": "Fraction of cases where the autorater agreed with the human raters.", "format": "float" }, "humanPreferenceBaselineModelWinRate": { "format": "float", "description": "Percentage of time humans decided the baseline model had the better response.", "type": "number" }, "truePositiveCount": { "description": "Number of examples where both the autorater and humans decided that the model had the better response.", "type": "string", "format": "int64" }, "trueNegativeCount": { "format": "int64", "description": "Number of examples where both the autorater and humans decided that the model had the worse response.", "type": "string" }, "baselineModelWinRate": { "format": "float", "type": "number", "description": "Percentage of time the autorater decided the baseline model had the better response." }, "f1Score": { "type": "number", "description": "Harmonic mean of precision and recall.", "format": "float" }, "modelWinRate": { "description": "Percentage of time the autorater decided the model had the better response.", "format": "float", "type": "number" }, "cohensKappa": { "type": "number", "format": "float", "description": "A measurement of agreement between the autorater and human raters that takes the likelihood of random agreement into account." }, "falseNegativeCount": { "type": "string", "format": "int64", "description": "Number of examples where the autorater chose the baseline model, but humans preferred the model." } }, "id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics" }, "GoogleCloudAiplatformV1beta1ListPipelineJobsResponse": { "properties": { "nextPageToken": { "description": "A token to retrieve the next page of results. Pass to ListPipelineJobsRequest.page_token to obtain that page.", "type": "string" }, "pipelineJobs": { "items": { "$ref": "GoogleCloudAiplatformV1beta1PipelineJob" }, "type": "array", "description": "List of PipelineJobs in the requested page." } }, "description": "Response message for PipelineService.ListPipelineJobs", "id": "GoogleCloudAiplatformV1beta1ListPipelineJobsResponse", "type": "object" }, "GoogleCloudAiplatformV1beta1SearchMigratableResourcesResponse": { "id": "GoogleCloudAiplatformV1beta1SearchMigratableResourcesResponse", "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "The standard next-page token. The migratable_resources may not fill page_size in SearchMigratableResourcesRequest even when there are subsequent pages." }, "migratableResources": { "items": { "$ref": "GoogleCloudAiplatformV1beta1MigratableResource" }, "type": "array", "description": "All migratable resources that can be migrated to the location specified in the request." } }, "description": "Response message for MigrationService.SearchMigratableResources." }, "GoogleCloudAiplatformV1beta1ListRagDataSchemasResponse": { "description": "Response message for VertexRagDataService.ListRagDataSchemas.", "id": "GoogleCloudAiplatformV1beta1ListRagDataSchemasResponse", "type": "object", "properties": { "nextPageToken": { "description": "A token to retrieve the next page of results. Pass to ListRagDataSchemasRequest.page_token to obtain that page.", "type": "string" }, "ragDataSchemas": { "description": "List of RagDataSchemas in the requested page.", "items": { "$ref": "GoogleCloudAiplatformV1beta1RagDataSchema" }, "type": "array" } } }, "GenaiVertexV1beta1StepDeltaData": { "id": "GenaiVertexV1beta1StepDeltaData", "type": "object", "properties": { "video": { "$ref": "GenaiVertexV1beta1VideoDelta" }, "argumentsDelta": { "$ref": "GenaiVertexV1beta1ArgumentsDelta" }, "thoughtSummary": { "$ref": "GenaiVertexV1beta1ThoughtSummaryDelta" }, "document": { "$ref": "GenaiVertexV1beta1DocumentDelta" }, "image": { "$ref": "GenaiVertexV1beta1ImageDelta" }, "audio": { "$ref": "GenaiVertexV1beta1AudioDelta" }, "functionResult": { "$ref": "GenaiVertexV1beta1FunctionResultDelta" }, "serverToolCall": { "$ref": "GenaiVertexV1beta1ServerToolCallDelta" }, "textAnnotationDelta": { "$ref": "GenaiVertexV1beta1TextAnnotationDelta" }, "text": { "$ref": "GenaiVertexV1beta1TextDelta" }, "thoughtSignature": { "$ref": "GenaiVertexV1beta1ThoughtSignatureDelta" }, "serverToolResult": { "$ref": "GenaiVertexV1beta1ServerToolResultDelta" } } }, "GoogleCloudAiplatformV1beta1GroundingChunkMapsRoute": { "id": "GoogleCloudAiplatformV1beta1GroundingChunkMapsRoute", "description": "Route information from Google Maps.", "type": "object", "properties": { "encodedPolyline": { "type": "string", "description": "An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm" }, "duration": { "description": "The total duration of the route.", "type": "string", "format": "google-duration" }, "distanceMeters": { "format": "int32", "description": "The total distance of the route, in meters.", "type": "integer" } } }, "GoogleCloudAiplatformV1beta1GenerateMemoriesRequestDirectContentsSource": { "id": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequestDirectContentsSource", "description": "Defines a direct source of content from which to generate the memories.", "properties": { "events": { "items": { "$ref": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequestDirectContentsSourceEvent" }, "type": "array", "description": "Required. The source content (i.e. chat history) to generate memories from." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1EntityType": { "type": "object", "properties": { "monitoringConfig": { "description": "Optional. The default monitoring configuration for all Features with value type (Feature.ValueType) BOOL, STRING, DOUBLE or INT64 under this EntityType. If this is populated with [FeaturestoreMonitoringConfig.monitoring_interval] specified, snapshot analysis monitoring is enabled. Otherwise, snapshot analysis monitoring is disabled.", "$ref": "GoogleCloudAiplatformV1beta1FeaturestoreMonitoringConfig" }, "name": { "description": "Immutable. Name of the EntityType. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore.", "type": "string" }, "satisfiesPzs": { "type": "boolean", "description": "Output only. Reserved for future use.", "readOnly": true }, "updateTime": { "type": "string", "readOnly": true, "description": "Output only. Timestamp when this EntityType was most recently updated.", "format": "google-datetime" }, "etag": { "type": "string", "description": "Optional. Used to perform a consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens." }, "offlineStorageTtlDays": { "type": "integer", "format": "int32", "description": "Optional. Config for data retention policy in offline storage. TTL in days for feature values that will be stored in offline storage. The Feature Store offline storage periodically removes obsolete feature values older than `offline_storage_ttl_days` since the feature generation time. If unset (or explicitly set to 0), default to 4000 days TTL." }, "labels": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Optional. The labels with user-defined metadata to organize your EntityTypes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one EntityType (System labels are excluded).\" System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable." }, "satisfiesPzi": { "readOnly": true, "description": "Output only. Reserved for future use.", "type": "boolean" }, "description": { "type": "string", "description": "Optional. Description of the EntityType." }, "createTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. Timestamp when this EntityType was created." } }, "id": "GoogleCloudAiplatformV1beta1EntityType", "description": "An entity type is a type of object in a system that needs to be modeled and have stored information about. For example, driver is an entity type, and driver0 is an instance of an entity type driver." }, "GoogleCloudAiplatformV1beta1RagFileChunkingConfig": { "id": "GoogleCloudAiplatformV1beta1RagFileChunkingConfig", "description": "Specifies the size and overlap of chunks for RagFiles.", "type": "object", "properties": { "chunkOverlap": { "type": "integer", "deprecated": true, "format": "int32", "description": "The overlap between chunks." }, "fixedLengthChunking": { "description": "Specifies the fixed length chunking config.", "$ref": "GoogleCloudAiplatformV1beta1RagFileChunkingConfigFixedLengthChunking" }, "chunkSize": { "deprecated": true, "type": "integer", "description": "The size of the chunks.", "format": "int32" } } }, "GoogleCloudAiplatformV1beta1A2ATaskRecordMetadataChange": { "id": "GoogleCloudAiplatformV1beta1A2ATaskRecordMetadataChange", "properties": { "updateMask": { "type": "string", "description": "Optional. A field mask indicating which metadata paths changed. If unset, all fields are updated.", "format": "google-fieldmask" }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Required. The updated task metadata after the change. This is a partial update that will be merged with the existing metadata.", "type": "object" } }, "type": "object", "description": "An event payload describing a change to the task-level metadata." }, "GoogleCloudAiplatformV1beta1UpgradeNotebookRuntimeRequest": { "properties": {}, "type": "object", "description": "Request message for NotebookService.UpgradeNotebookRuntime.", "id": "GoogleCloudAiplatformV1beta1UpgradeNotebookRuntimeRequest" }, "GoogleCloudAiplatformV1beta1TrajectoryPrecisionSpec": { "id": "GoogleCloudAiplatformV1beta1TrajectoryPrecisionSpec", "type": "object", "properties": {}, "description": "Spec for TrajectoryPrecision metric - returns a float score based on average precision of individual tool calls." }, "GenaiVertexV1beta1ContentList": { "properties": { "contents": { "description": "The contents of the list.", "type": "array", "items": { "$ref": "GenaiVertexV1beta1Content" } } }, "id": "GenaiVertexV1beta1ContentList", "type": "object", "description": "A list of Content." }, "GoogleCloudAiplatformV1beta1NotebookExecutionJobDirectNotebookSource": { "description": "The content of the input notebook in ipynb format.", "type": "object", "properties": { "content": { "description": "The base64-encoded contents of the input notebook file.", "type": "string", "format": "byte" } }, "id": "GoogleCloudAiplatformV1beta1NotebookExecutionJobDirectNotebookSource" }, "GoogleCloudAiplatformV1beta1Metric": { "type": "object", "properties": { "pairwiseMetricSpec": { "$ref": "GoogleCloudAiplatformV1beta1PairwiseMetricSpec", "description": "Spec for pairwise metric." }, "exactMatchSpec": { "$ref": "GoogleCloudAiplatformV1beta1ExactMatchSpec", "description": "Spec for exact match metric." }, "rougeSpec": { "description": "Spec for rouge metric.", "$ref": "GoogleCloudAiplatformV1beta1RougeSpec" }, "bleuSpec": { "description": "Spec for bleu metric.", "$ref": "GoogleCloudAiplatformV1beta1BleuSpec" }, "metadata": { "$ref": "GoogleCloudAiplatformV1beta1MetricMetadata", "description": "Optional. Metadata about the metric, used for visualization and organization." }, "predefinedMetricSpec": { "description": "The spec for a pre-defined metric.", "$ref": "GoogleCloudAiplatformV1beta1PredefinedMetricSpec" }, "pointwiseMetricSpec": { "$ref": "GoogleCloudAiplatformV1beta1PointwiseMetricSpec", "description": "Spec for pointwise metric." }, "aggregationMetrics": { "type": "array", "description": "Optional. The aggregation metrics to use.", "items": { "enum": [ "AGGREGATION_METRIC_UNSPECIFIED", "AVERAGE", "MODE", "STANDARD_DEVIATION", "VARIANCE", "MINIMUM", "MAXIMUM", "MEDIAN", "PERCENTILE_P90", "PERCENTILE_P95", "PERCENTILE_P99" ], "type": "string", "enumDescriptions": [ "Unspecified aggregation metric.", "Average aggregation metric. Not supported for Pairwise metric.", "Mode aggregation metric.", "Standard deviation aggregation metric. Not supported for pairwise metric.", "Variance aggregation metric. Not supported for pairwise metric.", "Minimum aggregation metric. Not supported for pairwise metric.", "Maximum aggregation metric. Not supported for pairwise metric.", "Median aggregation metric. Not supported for pairwise metric.", "90th percentile aggregation metric. Not supported for pairwise metric.", "95th percentile aggregation metric. Not supported for pairwise metric.", "99th percentile aggregation metric. Not supported for pairwise metric." ] } }, "llmBasedMetricSpec": { "description": "Spec for an LLM based metric.", "$ref": "GoogleCloudAiplatformV1beta1LLMBasedMetricSpec" }, "computationBasedMetricSpec": { "$ref": "GoogleCloudAiplatformV1beta1ComputationBasedMetricSpec", "description": "Spec for a computation based metric." }, "customCodeExecutionSpec": { "$ref": "GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec", "description": "Spec for Custom Code Execution metric." } }, "description": "The metric used for running evaluations.", "id": "GoogleCloudAiplatformV1beta1Metric" }, "GoogleCloudAiplatformV1beta1GenAiAdvancedFeaturesConfig": { "properties": { "ragConfig": { "$ref": "GoogleCloudAiplatformV1beta1GenAiAdvancedFeaturesConfigRagConfig", "description": "Configuration for Retrieval Augmented Generation feature." } }, "id": "GoogleCloudAiplatformV1beta1GenAiAdvancedFeaturesConfig", "description": "Configuration for GenAiAdvancedFeatures.", "type": "object" }, "GoogleCloudAiplatformV1beta1FeatureOnlineStoreBigtable": { "properties": { "bigtableMetadata": { "readOnly": true, "description": "Output only. Metadata of the Bigtable instance. Output only.", "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreBigtableBigtableMetadata" }, "autoScaling": { "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreBigtableAutoScaling", "description": "Required. Autoscaling config applied to Bigtable Instance." }, "enableDirectBigtableAccess": { "description": "Optional. It true, enable direct access to the Bigtable instance.", "type": "boolean" }, "zone": { "type": "string", "description": "Optional. The zone where the underlying Bigtable cluster for the primary Bigtable instance will be provisioned. Only the zone must be provided. For example, only \"us-central1-a\" should be provided." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreBigtable" }, "GoogleCloudAiplatformV1beta1ExecutableCode": { "description": "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.", "properties": { "id": { "description": "Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`.", "type": "string" }, "code": { "description": "Required. The code to be executed.", "type": "string" }, "language": { "enum": [ "LANGUAGE_UNSPECIFIED", "PYTHON" ], "enumDescriptions": [ "Unspecified language. This value should not be used.", "Python \u003e= 3.10, with numpy and simpy available." ], "type": "string", "description": "Required. Programming language of the `code`." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ExecutableCode" }, "GenaiVertexV1beta1FileCitation": { "description": "A file citation annotation.", "properties": { "fileName": { "description": "The name of the file.", "type": "string" }, "mediaId": { "description": "Media ID in-case of image citations, if applicable.", "type": "string" }, "pageNumber": { "format": "int32", "type": "integer", "description": "Page number of the cited document, if applicable." }, "customMetadata": { "description": "User provided metadata about the retrieved context.", "$ref": "GenaiVertexV1beta1Struct" }, "documentUri": { "type": "string", "description": "The URI of the file." }, "source": { "type": "string", "description": "Source attributed for a portion of the text." } }, "id": "GenaiVertexV1beta1FileCitation", "type": "object" }, "GoogleCloudAiplatformV1beta1Endpoint": { "id": "GoogleCloudAiplatformV1beta1Endpoint", "description": "Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.", "type": "object", "properties": { "genAiAdvancedFeaturesConfig": { "$ref": "GoogleCloudAiplatformV1beta1GenAiAdvancedFeaturesConfig", "description": "Optional. Configuration for GenAiAdvancedFeatures. If the endpoint is serving GenAI models, advanced features like native RAG integration can be configured. Currently, only Model Garden models are supported." }, "clientConnectionConfig": { "$ref": "GoogleCloudAiplatformV1beta1ClientConnectionConfig", "description": "Configurations that are applied to the endpoint for online prediction." }, "displayName": { "description": "Required. The display name of the Endpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters.", "type": "string" }, "trafficSplit": { "additionalProperties": { "type": "integer", "format": "int32" }, "type": "object", "description": "A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment." }, "satisfiesPzi": { "readOnly": true, "description": "Output only. Reserved for future use.", "type": "boolean" }, "etag": { "type": "string", "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens." }, "predictRequestResponseLoggingConfig": { "$ref": "GoogleCloudAiplatformV1beta1PredictRequestResponseLoggingConfig", "description": "Configures the request-response logging for online prediction." }, "dedicatedEndpointEnabled": { "description": "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 limitation will be removed soon.", "type": "boolean" }, "deployedModels": { "description": "Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.", "readOnly": true, "items": { "$ref": "GoogleCloudAiplatformV1beta1DeployedModel" }, "type": "array" }, "publisherModelConfig": { "description": "Optional. Configuration for a Publisher Model. This message contains details about a publisher model used with this Endpoint, such as logging config or data sharing settings.", "$ref": "GoogleCloudAiplatformV1beta1PublisherModelConfig" }, "description": { "type": "string", "description": "The description of the Endpoint." }, "createTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. Timestamp when this Endpoint was created." }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" }, "network": { "description": "Optional. The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where `{project}` is a project number, as in `12345`, and `{network}` is network name.", "type": "string" }, "dedicatedEndpointDns": { "type": "string", "readOnly": true, "description": "Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Depending on the features enabled, uid might be a random number or a string. For example, if fast_tryout is enabled, uid will be fasttryout. Format: `https://{endpoint_id}.{region}-{uid}.prediction.vertexai.goog`." }, "name": { "description": "Identifier. The resource name of the Endpoint.", "type": "string" }, "updateTime": { "description": "Output only. Timestamp when this Endpoint was last updated.", "type": "string", "format": "google-datetime", "readOnly": true }, "gdcConfig": { "description": "Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment.", "$ref": "GoogleCloudAiplatformV1beta1GdcConfig" }, "privateServiceConnectConfig": { "$ref": "GoogleCloudAiplatformV1beta1PrivateServiceConnectConfig", "description": "Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive." }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The labels with user-defined metadata to organize your Endpoints. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels." }, "modelDeploymentMonitoringJob": { "readOnly": true, "type": "string", "description": "Output only. Resource name of the Model Monitoring job associated with this Endpoint if monitoring is enabled by JobService.CreateModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`" }, "encryptionSpec": { "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec", "description": "Customer-managed encryption key spec for an Endpoint. If set, this Endpoint and all sub-resources of this Endpoint will be secured by this key." }, "enablePrivateServiceConnect": { "deprecated": true, "description": "Deprecated: If true, expose the Endpoint via private service connect. Only one of the fields, network or enable_private_service_connect, can be set.", "type": "boolean" } } }, "GoogleCloudAiplatformV1beta1ListRagMetadataResponse": { "id": "GoogleCloudAiplatformV1beta1ListRagMetadataResponse", "properties": { "nextPageToken": { "description": "A token to retrieve the next page of results. Pass to ListRagMetadataRequest.page_token to obtain that page.", "type": "string" }, "ragMetadata": { "description": "List of RagMetadata in the requested page.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1RagMetadata" } } }, "type": "object", "description": "Response message for VertexRagDataService.ListRagMetadata." }, "GoogleCloudAiplatformV1beta1SearchEntryPoint": { "description": "An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application.", "id": "GoogleCloudAiplatformV1beta1SearchEntryPoint", "type": "object", "properties": { "renderedContent": { "description": "Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result.", "type": "string" }, "sdkBlob": { "description": "Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI.", "type": "string", "format": "byte" } } }, "GoogleCloudAiplatformV1beta1ReservationAffinity": { "properties": { "values": { "items": { "type": "string" }, "description": "Optional. Corresponds to the label values of a reservation resource. This must be the resource name of the reservation, reservation block, or reservation sub- block.", "type": "array" }, "reservationAffinityType": { "description": "Required. Specifies the reservation affinity type.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "NO_RESERVATION", "ANY_RESERVATION", "SPECIFIC_RESERVATION" ], "enumDescriptions": [ "Default value. This should not be used.", "Do not consume from any reserved capacity, only use on-demand.", "Consume any reservation available, falling back to on-demand.", "Consume from a specific reservation. When chosen, the reservation must be identified via the `key` and `values` fields." ] }, "key": { "description": "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.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1ReservationAffinity", "type": "object", "description": "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." }, "GoogleCloudAiplatformV1beta1ListCustomJobsResponse": { "description": "Response message for JobService.ListCustomJobs", "type": "object", "id": "GoogleCloudAiplatformV1beta1ListCustomJobsResponse", "properties": { "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results. Pass to ListCustomJobsRequest.page_token to obtain that page." }, "customJobs": { "description": "List of CustomJobs in the requested page.", "items": { "$ref": "GoogleCloudAiplatformV1beta1CustomJob" }, "type": "array" } } }, "GoogleCloudAiplatformV1beta1PipelineTaskExecutorDetail": { "properties": { "customJobDetail": { "readOnly": true, "description": "Output only. The detailed info for a custom job executor.", "$ref": "GoogleCloudAiplatformV1beta1PipelineTaskExecutorDetailCustomJobDetail" }, "containerDetail": { "readOnly": true, "description": "Output only. The detailed info for a container executor.", "$ref": "GoogleCloudAiplatformV1beta1PipelineTaskExecutorDetailContainerDetail" } }, "description": "The runtime detail of a pipeline executor.", "type": "object", "id": "GoogleCloudAiplatformV1beta1PipelineTaskExecutorDetail" }, "GoogleCloudAiplatformV1beta1TaskOutputChange": { "type": "object", "description": "An event representing a change to the task's outputs.", "id": "GoogleCloudAiplatformV1beta1TaskOutputChange", "properties": { "taskArtifactChange": { "$ref": "GoogleCloudAiplatformV1beta1TaskArtifactChange", "description": "Required. A granular change to the list of artifacts." } } }, "GoogleCloudAiplatformV1beta1DatasetCustomMetric": { "description": "Defines a custom dataset-level aggregation.", "type": "object", "properties": { "displayName": { "description": "Optional. A display name for this custom summary metric. Used to prefix keys in the output summaryMetrics map. If not provided, a default name like \"dataset_custom_metric_1\", \"dataset_custom_metric_2\", etc., will be generated based on the order in the repeated field.", "type": "string" }, "aggregationFunction": { "type": "string", "description": "Required. The Python code string containing the aggregation function. Expected function signature: `def aggregate(instances: list[dict[str, Any]]) -\u003e dict[str, float]:` The `instances` argument is a list of dictionaries, where each dictionary represents a single evaluation result item. The structure of each dictionary corresponds to the fields in the `EvaluationResult` message. This includes: - `\"request\"`: Contains the original input data and model inputs (from `EvaluationResult.EvaluationRequest`). - `\"candidate_results\"`: Contains the results of any instance-level metrics (from `EvaluationResult.CandidateResults`). Example of a single item in the `instances` list: { \"request\": { \"prompt\": {\"text\": \"What is the capital of France?\"}, \"golden_response\": {\"text\": \"Paris\"}, \"candidate_responses\": [{\"candidate\": \"model-v1\", \"text\": \"Paris\"}] }, \"candidate_results\": [ {\"metric\": \"exact_match\", \"score\": 1.0}, {\"metric\": \"bleu\", \"score\": 0.9} ] }" } }, "id": "GoogleCloudAiplatformV1beta1DatasetCustomMetric" }, "GoogleCloudAiplatformV1beta1GenerateLossClustersRequestEvaluationResultList": { "description": "A wrapper to allow providing a list of items inline.", "properties": { "evaluationResults": { "description": "Required. The list of evaluation results to analyze.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationResult" } } }, "id": "GoogleCloudAiplatformV1beta1GenerateLossClustersRequestEvaluationResultList", "type": "object" }, "GoogleCloudAiplatformV1beta1Model": { "properties": { "checkpoints": { "description": "Optional. Output only. The checkpoints of the model.", "readOnly": true, "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Checkpoint" } }, "predictSchemata": { "description": "The schemata that describe formats of the Model's predictions and explanations as given and returned via PredictionService.Predict and PredictionService.Explain.", "$ref": "GoogleCloudAiplatformV1beta1PredictSchemata" }, "originalModelInfo": { "$ref": "GoogleCloudAiplatformV1beta1ModelOriginalModelInfo", "readOnly": true, "description": "Output only. If this Model is a copy of another Model, this contains info about the original." }, "versionId": { "description": "Output only. Immutable. The version ID of the model. A new version is committed when a new model version is uploaded or trained under an existing model id. It is an auto-incrementing decimal number in string representation.", "readOnly": true, "type": "string" }, "supportedDeploymentResourcesTypes": { "type": "array", "items": { "enumDescriptions": [ "Should not be used.", "Resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration.", "Resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.", "Resources that can be shared by multiple DeployedModels. A pre-configured DeploymentResourcePool is required." ], "enum": [ "DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED", "DEDICATED_RESOURCES", "AUTOMATIC_RESOURCES", "SHARED_RESOURCES" ], "type": "string" }, "description": "Output only. When this Model is deployed, its prediction resources are described by the `prediction_resources` field of the Endpoint.deployed_models object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an Endpoint and does not support online predictions (PredictionService.Predict or PredictionService.Explain). Such a Model can serve predictions by using a BatchPredictionJob, if it has at least one entry each in supported_input_storage_formats and supported_output_storage_formats.", "readOnly": true }, "versionAliases": { "type": "array", "items": { "type": "string" }, "description": "User provided version aliases so that a model version can be referenced via alias (i.e. `projects/{project}/locations/{location}/models/{model_id}@{version_alias}` instead of auto-generated version id (i.e. `projects/{project}/locations/{location}/models/{model_id}@{version_id})`. The format is a-z{0,126}[a-z0-9] to distinguish from version_id. A default version alias will be created for the first version of the model, and there must be exactly one default version alias for a model." }, "labels": { "description": "The labels with user-defined metadata to organize your Models. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.", "type": "object", "additionalProperties": { "type": "string" } }, "etag": { "type": "string", "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens." }, "versionCreateTime": { "type": "string", "description": "Output only. Timestamp when this version was created.", "readOnly": true, "format": "google-datetime" }, "trainingPipeline": { "type": "string", "description": "Output only. The resource name of the TrainingPipeline that uploaded this Model, if any.", "readOnly": true }, "satisfiesPzi": { "type": "boolean", "readOnly": true, "description": "Output only. Reserved for future use." }, "metadataSchemaUri": { "type": "string", "description": "Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Model, that is specific to it. Unset if the Model does not have any additional information. 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 additional metadata is needed, this field 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." }, "deployedModels": { "description": "Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.", "items": { "$ref": "GoogleCloudAiplatformV1beta1DeployedModelRef" }, "type": "array", "readOnly": true }, "name": { "type": "string", "description": "Identifier. The resource name of the Model." }, "versionDescription": { "type": "string", "description": "The description of this version." }, "displayName": { "description": "Required. The display name of the Model. The name can be up to 128 characters long and can consist of any UTF-8 characters.", "type": "string" }, "explanationSpec": { "description": "The default explanation specification for this Model. The Model can be used for requesting explanation after being deployed if it is populated. The Model can be used for batch explanation if it is populated. All fields of the explanation_spec can be overridden by explanation_spec of DeployModelRequest.deployed_model, or explanation_spec of BatchPredictionJob. If the default explanation specification is not set for this Model, this Model can still be used for requesting explanation by setting explanation_spec of DeployModelRequest.deployed_model and for batch explanation by setting explanation_spec of BatchPredictionJob.", "$ref": "GoogleCloudAiplatformV1beta1ExplanationSpec" }, "updateTime": { "format": "google-datetime", "description": "Output only. Timestamp when this Model was most recently updated.", "readOnly": true, "type": "string" }, "artifactUri": { "type": "string", "description": "Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not required for AutoML Models." }, "supportedOutputStorageFormats": { "type": "array", "items": { "type": "string" }, "description": "Output only. The formats this Model supports in BatchPredictionJob.output_config. If both PredictSchemata.instance_schema_uri and PredictSchemata.prediction_schema_uri exist, the predictions are returned together with their instances. In other words, the prediction has the original instance data first, followed by the actual prediction content (as per the schema). The possible formats are: * `jsonl` The JSON Lines format, where each prediction is a single line. Uses GcsDestination. * `csv` The CSV format, where each prediction is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsDestination. * `bigquery` Each prediction is a single row in a BigQuery table, uses BigQueryDestination . If this Model doesn't support any of these formats it means it cannot be used with a BatchPredictionJob. However, if it has supported_deployment_resources_types, it could serve online predictions by using PredictionService.Predict or PredictionService.Explain.", "readOnly": true }, "encryptionSpec": { "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec", "description": "Customer-managed encryption key spec for a Model. If set, this Model and all sub-resources of this Model will be secured by this key." }, "versionUpdateTime": { "description": "Output only. Timestamp when this version was most recently updated.", "type": "string", "format": "google-datetime", "readOnly": true }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when this Model was uploaded into Vertex AI." }, "supportedInputStorageFormats": { "type": "array", "description": "Output only. The formats this Model supports in BatchPredictionJob.input_config. If PredictSchemata.instance_schema_uri exists, the instances should be given as per that schema. The possible formats are: * `jsonl` The JSON Lines format, where each instance is a single line. Uses GcsSource. * `csv` The CSV format, where each instance is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsSource. * `tf-record` The TFRecord format, where each instance is a single record in tfrecord syntax. Uses GcsSource. * `tf-record-gzip` Similar to `tf-record`, but the file is gzipped. Uses GcsSource. * `bigquery` Each instance is a single row in BigQuery. Uses BigQuerySource. * `file-list` Each line of the file is the location of an instance to process, uses `gcs_source` field of the InputConfig object. If this Model doesn't support any of these formats it means it cannot be used with a BatchPredictionJob. However, if it has supported_deployment_resources_types, it could serve online predictions by using PredictionService.Predict or PredictionService.Explain.", "readOnly": true, "items": { "type": "string" } }, "metadata": { "type": "any", "description": "Immutable. An additional information about the Model; the schema of the metadata can be found in metadata_schema. Unset if the Model does not have any additional information." }, "metadataArtifact": { "description": "Output only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.", "type": "string", "readOnly": true }, "baseModelSource": { "$ref": "GoogleCloudAiplatformV1beta1ModelBaseModelSource", "description": "Optional. User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models." }, "defaultCheckpointId": { "description": "The default checkpoint id of a model version.", "type": "string" }, "supportedExportFormats": { "items": { "$ref": "GoogleCloudAiplatformV1beta1ModelExportFormat" }, "type": "array", "description": "Output only. The formats in which this Model may be exported. If empty, this Model is not available for export.", "readOnly": true }, "containerSpec": { "description": "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.", "$ref": "GoogleCloudAiplatformV1beta1ModelContainerSpec" }, "description": { "description": "The description of the Model.", "type": "string" }, "satisfiesPzs": { "readOnly": true, "type": "boolean", "description": "Output only. Reserved for future use." }, "modelSourceInfo": { "description": "Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or saved and tuned from Genie or Model Garden.", "$ref": "GoogleCloudAiplatformV1beta1ModelSourceInfo", "readOnly": true } }, "type": "object", "description": "A trained machine learning Model.", "id": "GoogleCloudAiplatformV1beta1Model" }, "GoogleCloudAiplatformV1beta1A2ATaskRecordMessage": { "properties": { "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "Optional. Additional context or parameters related to the message. Extensions can be used to strongly type metadata values for specific use cases." }, "messageId": { "type": "string", "description": "Required. The unique identifier of the message." }, "role": { "enum": [ "ROLE_UNSPECIFIED", "USER", "AGENT" ], "description": "Required. The role of the sender of the message.", "type": "string", "enumDescriptions": [ "The role is unspecified.", "The message is from the client to the server.", "The message is from the server to the client." ] }, "referenceTaskIds": { "type": "array", "items": { "type": "string" }, "description": "Optional. The IDs of other tasks referenced by this message." }, "extensions": { "items": { "type": "string" }, "description": "Optional. A2A protocol extensions associated with the message.", "type": "array" }, "parts": { "items": { "$ref": "GoogleCloudAiplatformV1beta1A2APart" }, "description": "Required. The content parts that make up the message.", "type": "array" } }, "type": "object", "description": "Represents a single message in a conversation, compliant with the A2A specification.", "id": "GoogleCloudAiplatformV1beta1A2ATaskRecordMessage" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs": { "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoObjectTrackingInputs", "properties": { "modelType": { "type": "string", "enum": [ "MODEL_TYPE_UNSPECIFIED", "CLOUD", "MOBILE_VERSATILE_1", "MOBILE_CORAL_VERSATILE_1", "MOBILE_CORAL_LOW_LATENCY_1", "MOBILE_JETSON_VERSATILE_1", "MOBILE_JETSON_LOW_LATENCY_1" ], "enumDescriptions": [ "Should not be set.", "A model best tailored to be used within Google Cloud, and which c annot be exported. Default.", "A model that, in addition to being available within Google Cloud, can also be exported (see ModelService.ExportModel) as a TensorFlow or TensorFlow Lite model and used on a mobile or edge device afterwards.", "A versatile model that is meant to be exported (see ModelService.ExportModel) and used on a Google Coral device.", "A model that trades off quality for low latency, to be exported (see ModelService.ExportModel) and used on a Google Coral device.", "A versatile model that is meant to be exported (see ModelService.ExportModel) and used on an NVIDIA Jetson device.", "A model that trades off quality for low latency, to be exported (see ModelService.ExportModel) and used on an NVIDIA Jetson device." ] } }, "type": "object" }, "GenaiVertexV1beta1GoogleSearchResultContent": { "description": "Google Search result content.", "id": "GenaiVertexV1beta1GoogleSearchResultContent", "type": "object", "properties": { "isError": { "type": "boolean", "description": "Whether the Google Search resulted in an error." }, "result": { "type": "array", "description": "Required. The results of the Google Search.", "items": { "$ref": "GenaiVertexV1beta1GoogleSearchResultContentGoogleSearchResult" } } }, "deprecated": true }, "GoogleCloudAiplatformV1beta1ListEndpointsResponse": { "type": "object", "properties": { "endpoints": { "description": "List of Endpoints in the requested page.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Endpoint" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results. Pass to ListEndpointsRequest.page_token to obtain that page." } }, "id": "GoogleCloudAiplatformV1beta1ListEndpointsResponse", "description": "Response message for EndpointService.ListEndpoints." }, "GoogleCloudAiplatformV1beta1ToolCall": { "id": "GoogleCloudAiplatformV1beta1ToolCall", "properties": { "toolInput": { "description": "Optional. Spec for tool input", "type": "string" }, "toolName": { "type": "string", "description": "Required. Spec for tool name" } }, "description": "Spec for tool call.", "type": "object" }, "GoogleCloudAiplatformV1beta1DeployedIndex": { "id": "GoogleCloudAiplatformV1beta1DeployedIndex", "properties": { "pscAutomationConfigs": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1PSCAutomationConfig" }, "description": "Optional. If set for PSC deployed index, PSC connection will be automatically created after deployment is done and the endpoint information is populated in private_endpoints.psc_automated_endpoints." }, "reservedIpRanges": { "items": { "type": "string" }, "description": "Optional. A list of reserved ip ranges under the VPC network that can be used for this DeployedIndex. If set, we will deploy the index within the provided ip ranges. Otherwise, the index might be deployed to any ip ranges under the provided VPC network. The value should be the name of the address (https://cloud.google.com/compute/docs/reference/rest/v1/addresses) Example: ['vertex-ai-ip-range']. For more information about subnets and network IP ranges, please see https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges.", "type": "array" }, "enableDatapointUpsertLogging": { "description": "Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option.", "type": "boolean" }, "deployedIndexAuthConfig": { "description": "Optional. If set, the authentication is enabled for the private endpoint.", "$ref": "GoogleCloudAiplatformV1beta1DeployedIndexAuthConfig" }, "enableAccessLogging": { "description": "Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option.", "type": "boolean" }, "id": { "description": "Required. The user specified ID of the DeployedIndex. The ID can be up to 128 characters long and must start with a letter and only contain letters, numbers, and underscores. The ID must be unique within the project it is created in.", "type": "string" }, "automaticResources": { "$ref": "GoogleCloudAiplatformV1beta1AutomaticResources", "description": "Optional. A description of resources that the DeployedIndex uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2 (we don't provide SLA when min_replica_count=1). If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000." }, "displayName": { "type": "string", "description": "The display name of the DeployedIndex. If not provided upon creation, the Index's display_name is used." }, "dedicatedResources": { "$ref": "GoogleCloudAiplatformV1beta1DedicatedResources", "description": "Optional. A description of resources that are dedicated to the DeployedIndex, and that need a higher degree of manual configuration. The field min_replica_count must be set to a value strictly greater than 0, or else validation will fail. We don't provide SLA when min_replica_count=1. If max_replica_count is not set, the default value is min_replica_count. The max allowed replica count is 1000. Available machine types for SMALL shard: e2-standard-2 and all machine types available for MEDIUM and LARGE shard. Available machine types for MEDIUM shard: e2-standard-16 and all machine types available for LARGE shard. Available machine types for LARGE shard: e2-highmem-16, n2d-standard-32. n1-standard-16 and n1-standard-32 are still available, but we recommend e2-standard-16 and e2-highmem-16 for cost efficiency." }, "deploymentGroup": { "description": "Optional. The deployment group can be no longer than 64 characters (eg: 'test', 'prod'). If not set, we will use the 'default' deployment group. Creating `deployment_groups` with `reserved_ip_ranges` is a recommended practice when the peered network has multiple peering ranges. This creates your deployments from predictable IP spaces for easier traffic administration. Also, one deployment_group (except 'default') can only be used with the same reserved_ip_ranges which means if the deployment_group has been used with reserved_ip_ranges: [a, b, c], using it with [a, b] or [d, e] is disallowed. Note: we only support up to 5 deployment groups(not including 'default').", "type": "string" }, "privateEndpoints": { "readOnly": true, "description": "Output only. Provides paths for users to send requests directly to the deployed index services running on Cloud via private services access. This field is populated if network is configured.", "$ref": "GoogleCloudAiplatformV1beta1IndexPrivateEndpoints" }, "index": { "type": "string", "description": "Required. The name of the Index this is the deployment of. We may refer to this Index as the DeployedIndex's \"original\" Index." }, "indexSyncTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The DeployedIndex may depend on various data on its original Index. Additionally when certain changes to the original Index are being done (e.g. when what the Index contains is being changed) the DeployedIndex may be asynchronously updated in the background to reflect these changes. If this timestamp's value is at least the Index.update_time of the original Index, it means that this DeployedIndex and the original Index are in sync. If this timestamp is older, then to see which updates this DeployedIndex already contains (and which it does not), one must list the operations that are running on the original Index. Only the successfully completed Operations with update_time equal or before this sync time are contained in this DeployedIndex.", "type": "string" }, "createTime": { "description": "Output only. Timestamp when the DeployedIndex was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "deploymentTier": { "enum": [ "DEPLOYMENT_TIER_UNSPECIFIED", "STORAGE" ], "type": "string", "enumDescriptions": [ "Default deployment tier.", "Optimized for costs." ], "description": "Optional. The deployment tier that the index is deployed to. DEPLOYMENT_TIER_UNSPECIFIED will use a system-chosen default tier." } }, "description": "A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes.", "type": "object" }, "GoogleCloudAiplatformV1beta1ListCachedContentsResponse": { "id": "GoogleCloudAiplatformV1beta1ListCachedContentsResponse", "type": "object", "properties": { "cachedContents": { "items": { "$ref": "GoogleCloudAiplatformV1beta1CachedContent" }, "description": "List of cached contents.", "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "description": "Response with a list of CachedContents." }, "GoogleCloudAiplatformV1beta1FeatureMonitor": { "properties": { "name": { "description": "Identifier. Name of the FeatureMonitor. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}/featureMonitors/{featureMonitor}`", "type": "string" }, "scheduleConfig": { "$ref": "GoogleCloudAiplatformV1beta1ScheduleConfig", "description": "Required. Schedule config for the FeatureMonitor." }, "etag": { "type": "string", "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens." }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. Timestamp when this FeatureMonitor was created.", "format": "google-datetime" }, "description": { "description": "Optional. Description of the FeatureMonitor.", "type": "string" }, "labels": { "description": "Optional. The labels with user-defined metadata to organize your FeatureMonitor. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureMonitor(System labels are excluded).\" System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable.", "type": "object", "additionalProperties": { "type": "string" } }, "featureSelectionConfig": { "description": "Required. Feature selection config for the FeatureMonitor.", "$ref": "GoogleCloudAiplatformV1beta1FeatureSelectionConfig" }, "updateTime": { "format": "google-datetime", "description": "Output only. Timestamp when this FeatureMonitor was last updated.", "type": "string", "readOnly": true } }, "id": "GoogleCloudAiplatformV1beta1FeatureMonitor", "description": "Vertex AI Feature Monitor.", "type": "object" }, "GoogleCloudAiplatformV1beta1RemoveDatapointsRequest": { "type": "object", "description": "Request message for IndexService.RemoveDatapoints", "id": "GoogleCloudAiplatformV1beta1RemoveDatapointsRequest", "properties": { "datapointIds": { "type": "array", "items": { "type": "string" }, "description": "A list of datapoint ids to be deleted." } } }, "GoogleCloudAiplatformV1beta1LossExample": { "id": "GoogleCloudAiplatformV1beta1LossExample", "properties": { "evaluationItem": { "type": "string", "description": "Reference to the persisted EvalItem resource name. Format: projects/.../locations/.../evaluationItems/{item_id} Used when analysis is run on an EvalSet." }, "evaluationResult": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationResult", "description": "The full evaluation result object provided inline. Used when the analysis is performed on ephemeral data (without an EvaluationSet)." }, "failedRubrics": { "items": { "$ref": "GoogleCloudAiplatformV1beta1FailedRubric" }, "type": "array", "description": "The specific rubric(s) that failed and caused this example to be classified here. An example might fail multiple rubrics, but only specific ones trigger this loss pattern." } }, "description": "Represents a specific example of a loss pattern.", "type": "object" }, "GenaiVertexV1beta1Tool": { "id": "GenaiVertexV1beta1Tool", "properties": { "function": { "$ref": "GenaiVertexV1beta1Function", "description": "A function that can be used by the model." }, "computerUse": { "description": "Tool to support the model interacting directly with the computer.", "$ref": "GenaiVertexV1beta1ComputerUse" }, "googleMaps": { "description": "A tool that can be used by the model to search Google Maps.", "$ref": "GenaiVertexV1beta1GoogleMaps" }, "urlContext": { "$ref": "GenaiVertexV1beta1UrlContext", "description": "A tool that can be used by the model to fetch URL context." }, "googleSearch": { "description": "A tool that can be used by the model to search Google.", "$ref": "GenaiVertexV1beta1GoogleSearch" }, "mcpServer": { "$ref": "GenaiVertexV1beta1McpServer", "description": "A MCPServer is a server that can be called by the model to perform actions." }, "retrieval": { "description": "A tool that can be used by the model to retrieve files.", "$ref": "GenaiVertexV1beta1Retrieval" }, "fileSearch": { "description": "A tool that can be used by the model to search files.", "$ref": "GenaiVertexV1beta1FileSearch" }, "codeExecution": { "description": "A tool that can be used by the model to execute code.", "$ref": "GenaiVertexV1beta1CodeExecution" } }, "description": "A tool that can be used by the model.", "type": "object" }, "GoogleCloudAiplatformV1beta1TrajectoryExactMatchSpec": { "id": "GoogleCloudAiplatformV1beta1TrajectoryExactMatchSpec", "properties": {}, "type": "object", "description": "Spec for TrajectoryExactMatch metric - returns 1 if tool calls in the reference trajectory exactly match the predicted trajectory, else 0." }, "GoogleCloudAiplatformV1beta1SamplingStrategy": { "id": "GoogleCloudAiplatformV1beta1SamplingStrategy", "type": "object", "properties": { "randomSampleConfig": { "$ref": "GoogleCloudAiplatformV1beta1SamplingStrategyRandomSampleConfig", "description": "Random sample config. Will support more sampling strategies later." } }, "description": "Sampling Strategy for logging, can be for both training and prediction dataset." }, "GoogleCloudAiplatformV1beta1SummarizationQualityInput": { "type": "object", "description": "Input for summarization quality metric.", "properties": { "instance": { "description": "Required. Summarization quality instance.", "$ref": "GoogleCloudAiplatformV1beta1SummarizationQualityInstance" }, "metricSpec": { "$ref": "GoogleCloudAiplatformV1beta1SummarizationQualitySpec", "description": "Required. Spec for summarization quality score metric." } }, "id": "GoogleCloudAiplatformV1beta1SummarizationQualityInput" }, "GoogleCloudAiplatformV1beta1Tensorboard": { "description": "Tensorboard is a physical database that stores users' training metrics. A default Tensorboard is provided in each region of a Google Cloud project. If needed users can also create extra Tensorboards in their projects.", "type": "object", "properties": { "blobStoragePathPrefix": { "description": "Output only. Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a '/'.", "type": "string", "readOnly": true }, "createTime": { "type": "string", "description": "Output only. Timestamp when this Tensorboard was created.", "readOnly": true, "format": "google-datetime" }, "name": { "description": "Output only. Name of the Tensorboard. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "type": "string", "readOnly": true }, "labels": { "additionalProperties": { "type": "string" }, "type": "object", "description": "The labels with user-defined metadata to organize your Tensorboards. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Tensorboard (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable." }, "isDefault": { "description": "Used to indicate if the TensorBoard instance is the default one. Each project & region can have at most one default TensorBoard instance. Creation of a default TensorBoard instance and updating an existing TensorBoard instance to be default will mark all other TensorBoard instances (if any) as non default.", "type": "boolean" }, "satisfiesPzs": { "readOnly": true, "type": "boolean", "description": "Output only. Reserved for future use." }, "description": { "description": "Description of this Tensorboard.", "type": "string" }, "displayName": { "type": "string", "description": "Required. User provided name of this Tensorboard." }, "encryptionSpec": { "description": "Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.", "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec" }, "satisfiesPzi": { "readOnly": true, "description": "Output only. Reserved for future use.", "type": "boolean" }, "runCount": { "format": "int32", "readOnly": true, "description": "Output only. The number of Runs stored in this Tensorboard.", "type": "integer" }, "updateTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. Timestamp when this Tensorboard was last updated." }, "etag": { "type": "string", "description": "Used to perform a consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens." } }, "id": "GoogleCloudAiplatformV1beta1Tensorboard" }, "GenaiVertexV1beta1CodeMenderAgentConfigSessionConfig": { "properties": { "maxRounds": { "description": "The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout.", "type": "integer", "format": "int32" } }, "id": "GenaiVertexV1beta1CodeMenderAgentConfigSessionConfig", "description": "The configuration of CodeMender sessions.", "type": "object" }, "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecDeveloperConnectSource": { "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecDeveloperConnectSource", "type": "object", "properties": { "config": { "description": "Required. The Developer Connect configuration that defines the specific repository, revision, and directory to use as the source code root.", "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecDeveloperConnectConfig" } }, "description": "Specifies source code to be fetched from a Git repository managed through the Developer Connect service." }, "GoogleCloudAiplatformV1beta1AddContextChildrenRequest": { "id": "GoogleCloudAiplatformV1beta1AddContextChildrenRequest", "description": "Request message for MetadataService.AddContextChildren.", "properties": { "childContexts": { "items": { "type": "string" }, "type": "array", "description": "The resource names of the child Contexts." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1BatchImportEvaluatedAnnotationsRequest": { "type": "object", "properties": { "evaluatedAnnotations": { "description": "Required. Evaluated annotations resource to be imported.", "items": { "$ref": "GoogleCloudAiplatformV1beta1EvaluatedAnnotation" }, "type": "array" } }, "description": "Request message for ModelService.BatchImportEvaluatedAnnotations", "id": "GoogleCloudAiplatformV1beta1BatchImportEvaluatedAnnotationsRequest" }, "GenaiVertexV1beta1ToolCallDelta": { "properties": { "functionCall": { "$ref": "GenaiVertexV1beta1FunctionCallDelta" }, "codeExecutionCall": { "$ref": "GenaiVertexV1beta1CodeExecutionCallDelta" }, "urlContextCall": { "$ref": "GenaiVertexV1beta1UrlContextCallDelta" }, "googleSearchCall": { "$ref": "GenaiVertexV1beta1GoogleSearchCallDelta" }, "signature": { "format": "byte", "description": "A signature hash for backend validation.", "type": "string" }, "googleMapsCall": { "$ref": "GenaiVertexV1beta1GoogleMapsCallDelta" }, "mcpServerToolCall": { "$ref": "GenaiVertexV1beta1McpServerToolCallDelta" }, "id": { "description": "Required. A unique ID for this specific tool call.", "type": "string" }, "fileSearchCall": { "$ref": "GenaiVertexV1beta1FileSearchCallDelta" } }, "type": "object", "id": "GenaiVertexV1beta1ToolCallDelta" }, "GoogleCloudAiplatformV1beta1AgentResource": { "type": "object", "id": "GoogleCloudAiplatformV1beta1AgentResource", "properties": { "agentType": { "enumDescriptions": [ "The default value, used when the runtime type is unspecified.", "The agent runs on the Gemini Enterprise Agent Platform Agent Runtime (Reasoning Engine).", "The agent runs as a Google Cloud Run service.", "The agent runs as a workload on Google Kubernetes Engine.", "The agent runs on a Compute Engine instance.", "The agent runs on another runtime, such as a self-hosted, on-premises, or non-Google Cloud environment, or any runtime not represented by the values above." ], "description": "Required. The runtime type of the agent.", "type": "string", "enum": [ "AGENT_TYPE_UNSPECIFIED", "REASONING_ENGINE", "CLOUD_RUN_SERVICE", "GKE_WORKLOAD", "GCE_INSTANCE", "AGENT_TYPE_OTHER" ] }, "agent": { "description": "Required. The resource name or identifier of the agent to monitor. The format depends on `agent_type`: * `REASONING_ENGINE`: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` * `CLOUD_RUN_SERVICE`, `GKE_WORKLOAD`, `GCE_INSTANCE`: the resource name of the agent's runtime. * `AGENT_TYPE_OTHER`: a stable identifier for the agent.", "type": "string" }, "agentFramework": { "type": "string", "description": "Optional. The framework used to build the agent, orthogonal to the runtime `agent_type`.", "enum": [ "AGENT_FRAMEWORK_UNSPECIFIED", "ADK" ], "enumDescriptions": [ "The default value, used when the framework is unspecified.", "The agent is built with the Agent Development Kit (ADK)." ] }, "location": { "description": "Output only. The Google Cloud location (region) of the agent resource (for example, `us-central1`).", "readOnly": true, "type": "string" } }, "description": "Defines the identity of an agent being monitored." }, "GoogleCloudAiplatformV1beta1PairwiseMetricSpec": { "description": "Spec for pairwise metric.", "properties": { "candidateResponseFieldName": { "description": "Optional. The field name of the candidate response.", "type": "string" }, "systemInstruction": { "type": "string", "description": "Optional. System instructions for pairwise metric." }, "metricPromptTemplate": { "description": "Required. Metric prompt template for pairwise metric.", "type": "string" }, "baselineResponseFieldName": { "type": "string", "description": "Optional. The field name of the baseline response." }, "customOutputFormatConfig": { "description": "Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty.", "$ref": "GoogleCloudAiplatformV1beta1CustomOutputFormatConfig" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1PairwiseMetricSpec" }, "GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig": { "description": "The API secret.", "properties": { "apiKeySecretVersion": { "description": "Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}", "type": "string" }, "apiKeyString": { "type": "string", "description": "The API key string. Either this or `api_key_secret_version` must be set." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig": { "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig", "type": "object", "description": "Configuration for exporting test set predictions to a BigQuery table.", "properties": { "destinationBigqueryUri": { "description": "URI of desired destination BigQuery table. Expected format: `bq://{project_id}:{dataset_id}:{table}` If not specified, then results are exported to the following auto-created BigQuery table: `{project_id}:export_evaluated_examples_{model_name}_{yyyy_MM_dd'T'HH_mm_ss_SSS'Z'}.evaluated_examples`", "type": "string" }, "overrideExistingTable": { "type": "boolean", "description": "If true and an export destination is specified, then the contents of the destination are overwritten. Otherwise, if the export destination already exists, then the export operation fails." } } }, "GoogleCloudAiplatformV1beta1RemoveExamplesRequest": { "properties": { "storedContentsExampleFilter": { "description": "The metadata filters for StoredContentsExamples.", "$ref": "GoogleCloudAiplatformV1beta1StoredContentsExampleFilter" }, "exampleIds": { "type": "array", "items": { "type": "string" }, "description": "Optional. Example IDs to remove. If both metadata filters and Example IDs are specified, the metadata filters will be applied to the specified examples in order to identify which should be removed." } }, "id": "GoogleCloudAiplatformV1beta1RemoveExamplesRequest", "description": "Request message for ExampleStoreService.RemoveExamples.", "type": "object" }, "GoogleCloudAiplatformV1beta1DeleteOnlineEvaluatorOperationMetadata": { "type": "object", "description": "Metadata for the DeleteOnlineEvaluator operation.", "id": "GoogleCloudAiplatformV1beta1DeleteOnlineEvaluatorOperationMetadata", "properties": { "genericMetadata": { "description": "Generic operation metadata.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } } }, "GoogleCloudAiplatformV1beta1RagFileTransformationConfig": { "description": "Specifies the transformation config for RagFiles.", "properties": { "ragFileChunkingConfig": { "description": "Specifies the chunking config for RagFiles.", "$ref": "GoogleCloudAiplatformV1beta1RagFileChunkingConfig" } }, "id": "GoogleCloudAiplatformV1beta1RagFileTransformationConfig", "type": "object" }, "GoogleCloudAiplatformV1beta1UpsertExamplesResponseUpsertResult": { "id": "GoogleCloudAiplatformV1beta1UpsertExamplesResponseUpsertResult", "type": "object", "description": "The result for creating/updating a single example.", "properties": { "example": { "$ref": "GoogleCloudAiplatformV1beta1Example", "description": "The example created/updated successfully." }, "status": { "$ref": "GoogleRpcStatus", "description": "The error message of the example that was not created/updated successfully." } } }, "GoogleCloudAiplatformV1beta1SupervisedHyperParameters": { "type": "object", "properties": { "batchSize": { "description": "Optional. Batch size for tuning. This feature is only available for open source models.", "type": "string", "format": "int64" }, "learningRate": { "description": "Optional. Learning rate for tuning. Mutually exclusive with `learning_rate_multiplier`. This feature is only available for open source models.", "type": "number", "format": "double" }, "epochCount": { "type": "string", "format": "int64", "description": "Optional. Number of complete passes the model makes over the entire training dataset during training." }, "learningRateMultiplier": { "type": "number", "format": "double", "description": "Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models." }, "adapterSize": { "description": "Optional. Adapter size for tuning.", "enumDescriptions": [ "Adapter size is unspecified.", "Adapter size 1.", "Adapter size 2.", "Adapter size 4.", "Adapter size 8.", "Adapter size 16.", "Adapter size 32." ], "enum": [ "ADAPTER_SIZE_UNSPECIFIED", "ADAPTER_SIZE_ONE", "ADAPTER_SIZE_TWO", "ADAPTER_SIZE_FOUR", "ADAPTER_SIZE_EIGHT", "ADAPTER_SIZE_SIXTEEN", "ADAPTER_SIZE_THIRTY_TWO" ], "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1SupervisedHyperParameters", "description": "Hyperparameters for SFT." }, "GoogleCloudAiplatformV1beta1ModelMonitoringAnomaly": { "properties": { "tabularAnomaly": { "description": "Tabular anomaly.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringAnomalyTabularAnomaly" }, "modelMonitoringJob": { "type": "string", "description": "Model monitoring job resource name." }, "algorithm": { "description": "Algorithm used to calculated the metrics, eg: jensen_shannon_divergence, l_infinity.", "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ModelMonitoringAnomaly", "description": "Represents a single model monitoring anomaly." }, "GoogleCloudAiplatformV1beta1SchemaPredictInstanceTextExtractionPredictionInstance": { "description": "Prediction input format for Text Extraction.", "properties": { "content": { "type": "string", "description": "The text snippet to make the predictions on." }, "mimeType": { "type": "string", "description": "The MIME type of the text snippet. The supported MIME types are listed below. - text/plain" }, "key": { "type": "string", "description": "This field is only used for batch prediction. If a key is provided, the batch prediction result will by mapped to this key. If omitted, then the batch prediction result will contain the entire input instance. Vertex AI will not check if keys in the request are duplicates, so it is up to the caller to ensure the keys are unique." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaPredictInstanceTextExtractionPredictionInstance" }, "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponseEntityViewData": { "id": "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponseEntityViewData", "type": "object", "description": "Container to hold value(s), successive in time, for one Feature from the request.", "properties": { "value": { "$ref": "GoogleCloudAiplatformV1beta1FeatureValue", "description": "Feature value if a single value is requested." }, "values": { "$ref": "GoogleCloudAiplatformV1beta1FeatureValueList", "description": "Feature values list if values, successive in time, are requested. If the requested number of values is greater than the number of existing Feature values, nonexistent values are omitted instead of being returned as empty." } } }, "GoogleCloudAiplatformV1beta1FeatureGroupBigQuery": { "id": "GoogleCloudAiplatformV1beta1FeatureGroupBigQuery", "type": "object", "properties": { "entityIdColumns": { "type": "array", "description": "Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`.", "items": { "type": "string" } }, "dense": { "type": "boolean", "description": "Optional. If set, all feature values will be fetched from a single row per unique entityId including nulls. If not set, will collapse all rows for each unique entityId into a singe row with any non-null values if present, if no non-null values are present will sync null. ex: If source has schema `(entity_id, feature_timestamp, f0, f1)` and the following rows: `(e1, 2020-01-01T10:00:00.123Z, 10, 15)` `(e1, 2020-02-01T10:00:00.123Z, 20, null)` If dense is set, `(e1, 20, null)` is synced to online stores. If dense is not set, `(e1, 20, 15)` is synced to online stores." }, "staticDataSource": { "description": "Optional. Set if the data source is not a time-series.", "type": "boolean" }, "timeSeries": { "description": "Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureView ) will treat time-series sources. If not set, will treat the source as a time-series source with `feature_timestamp` as timestamp column and no scan boundary.", "$ref": "GoogleCloudAiplatformV1beta1FeatureGroupBigQueryTimeSeries" }, "bigQuerySource": { "$ref": "GoogleCloudAiplatformV1beta1BigQuerySource", "description": "Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View." } }, "description": "Input source type for BigQuery Tables and Views." }, "GoogleCloudAiplatformV1beta1VertexAISearchDataStoreSpec": { "type": "object", "properties": { "dataStore": { "type": "string", "description": "Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`" }, "filter": { "type": "string", "description": "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)" } }, "description": "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", "id": "GoogleCloudAiplatformV1beta1VertexAISearchDataStoreSpec" }, "GoogleCloudAiplatformV1beta1SafetyResult": { "properties": { "explanation": { "type": "string", "readOnly": true, "description": "Output only. Explanation for safety score." }, "score": { "readOnly": true, "description": "Output only. Safety score.", "format": "float", "type": "number" }, "confidence": { "description": "Output only. Confidence for safety score.", "format": "float", "readOnly": true, "type": "number" } }, "description": "Spec for safety result.", "id": "GoogleCloudAiplatformV1beta1SafetyResult", "type": "object" }, "GoogleCloudAiplatformV1beta1ModelContainerSpec": { "id": "GoogleCloudAiplatformV1beta1ModelContainerSpec", "type": "object", "properties": { "sharedMemorySizeMb": { "type": "string", "format": "int64", "description": "Immutable. The amount of the VM memory to reserve as the shared memory for the model in megabytes." }, "healthProbe": { "$ref": "GoogleCloudAiplatformV1beta1Probe", "description": "Immutable. Specification for Kubernetes readiness probe." }, "grpcPorts": { "description": "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.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Port" }, "type": "array" }, "healthRoute": { "description": "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).)", "type": "string" }, "startupProbe": { "$ref": "GoogleCloudAiplatformV1beta1Probe", "description": "Immutable. Specification for Kubernetes startup probe." }, "ports": { "description": "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).", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Port" } }, "env": { "description": "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).", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1EnvVar" } }, "imageUri": { "description": "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.", "type": "string" }, "invokeRoutePrefix": { "description": "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.", "type": "string" }, "deploymentTimeout": { "format": "google-duration", "type": "string", "description": "Immutable. Deployment timeout. Limit for deployment timeout is 2 hours." }, "command": { "type": "array", "description": "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).", "items": { "type": "string" } }, "predictRoute": { "description": "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).)", "type": "string" }, "livenessProbe": { "description": "Immutable. Specification for Kubernetes liveness probe.", "$ref": "GoogleCloudAiplatformV1beta1Probe" }, "args": { "type": "array", "description": "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).", "items": { "type": "string" } } }, "description": "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)." }, "GoogleCloudAiplatformV1beta1FeatureMonitorJob": { "type": "object", "id": "GoogleCloudAiplatformV1beta1FeatureMonitorJob", "properties": { "triggerType": { "type": "string", "enumDescriptions": [ "Trigger type unspecified.", "Triggered by periodic schedule.", "Triggered on demand by CreateFeatureMonitorJob request." ], "description": "Output only. Trigger type of the Feature Monitor Job.", "enum": [ "FEATURE_MONITOR_JOB_TRIGGER_UNSPECIFIED", "FEATURE_MONITOR_JOB_TRIGGER_PERIODIC", "FEATURE_MONITOR_JOB_TRIGGER_ON_DEMAND" ], "readOnly": true }, "finalStatus": { "description": "Output only. Final status of the FeatureMonitorJob.", "readOnly": true, "$ref": "GoogleRpcStatus" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when this FeatureMonitorJob was created. Creation of a FeatureMonitorJob means that the job is pending / waiting for sufficient resources but may not have started running yet.", "readOnly": true }, "labels": { "description": "Optional. The labels with user-defined metadata to organize your FeatureMonitorJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureMonitor(System labels are excluded).\" System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable.", "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "description": "Identifier. Name of the FeatureMonitorJob. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job}`.", "type": "string" }, "driftBaseFeatureMonitorJobId": { "readOnly": true, "type": "string", "description": "Output only. FeatureMonitorJob ID comparing to which the drift is calculated.", "format": "int64" }, "jobSummary": { "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitorJobJobSummary", "description": "Output only. Summary from the FeatureMonitorJob.", "readOnly": true }, "description": { "type": "string", "description": "Optional. Description of the FeatureMonitor." }, "driftBaseSnapshotTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Data snapshot time comparing to which the drift is calculated.", "type": "string" }, "featureSelectionConfig": { "description": "Output only. Feature selection config used when creating FeatureMonitorJob.", "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1FeatureSelectionConfig" } }, "description": "Vertex AI Feature Monitor Job." }, "GoogleCloudAiplatformV1beta1ReadTensorboardTimeSeriesDataResponse": { "properties": { "timeSeriesData": { "$ref": "GoogleCloudAiplatformV1beta1TimeSeriesData", "description": "The returned time series data." } }, "type": "object", "description": "Response message for TensorboardService.ReadTensorboardTimeSeriesData.", "id": "GoogleCloudAiplatformV1beta1ReadTensorboardTimeSeriesDataResponse" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionWindowConfig": { "type": "object", "description": "Config that contains the strategy used to generate sliding windows in time series training. A window is a series of rows that comprise the context up to the time of prediction, and the horizon following. The corresponding row for each window marks the start of the forecast horizon. Each window is used as an input example for training/evaluation.", "properties": { "column": { "description": "Name of the column that should be used to generate sliding windows. The column should contain either booleans or string booleans; if the value of the row is True, generate a sliding window with the horizon starting at that row. The column will not be used as a feature in training.", "type": "string" }, "maxCount": { "format": "int64", "type": "string", "description": "Maximum number of windows that should be generated across all time series." }, "strideLength": { "description": "Stride length used to generate input examples. Within one time series, every {$STRIDE_LENGTH} rows will be used to generate a sliding window.", "format": "int64", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionWindowConfig" }, "GoogleCloudAiplatformV1beta1DirectRawPredictRequest": { "description": "Request message for PredictionService.DirectRawPredict.", "properties": { "methodName": { "description": "Fully qualified name of the API method being invoked to perform predictions. Format: `/namespace.Service/Method/` Example: `/tensorflow.serving.PredictionService/Predict`", "type": "string" }, "input": { "type": "string", "format": "byte", "description": "The prediction input." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1DirectRawPredictRequest" }, "GoogleCloudAiplatformV1beta1BatchReadTensorboardTimeSeriesDataResponse": { "description": "Response message for TensorboardService.BatchReadTensorboardTimeSeriesData.", "type": "object", "properties": { "timeSeriesData": { "description": "The returned time series data.", "items": { "$ref": "GoogleCloudAiplatformV1beta1TimeSeriesData" }, "type": "array" } }, "id": "GoogleCloudAiplatformV1beta1BatchReadTensorboardTimeSeriesDataResponse" }, "GoogleCloudAiplatformV1beta1MigrateResourceRequestMigrateDataLabelingDatasetConfig": { "description": "Config for migrating Dataset in datalabeling.googleapis.com to Vertex AI's Dataset.", "type": "object", "id": "GoogleCloudAiplatformV1beta1MigrateResourceRequestMigrateDataLabelingDatasetConfig", "properties": { "dataset": { "description": "Required. Full resource name of data labeling Dataset. Format: `projects/{project}/datasets/{dataset}`.", "type": "string" }, "datasetDisplayName": { "type": "string", "description": "Optional. Display name of the Dataset in Vertex AI. System will pick a display name if unspecified." }, "migrateDataLabelingAnnotatedDatasetConfigs": { "description": "Optional. Configs for migrating AnnotatedDataset in datalabeling.googleapis.com to Vertex AI's SavedQuery. The specified AnnotatedDatasets have to belong to the datalabeling Dataset.", "items": { "$ref": "GoogleCloudAiplatformV1beta1MigrateResourceRequestMigrateDataLabelingDatasetConfigMigrateDataLabelingAnnotatedDatasetConfig" }, "type": "array" } } }, "GoogleCloudAiplatformV1beta1ImportModelEvaluationRequest": { "properties": { "modelEvaluation": { "description": "Required. Model evaluation resource to be imported.", "$ref": "GoogleCloudAiplatformV1beta1ModelEvaluation" } }, "description": "Request message for ModelService.ImportModelEvaluation", "id": "GoogleCloudAiplatformV1beta1ImportModelEvaluationRequest", "type": "object" }, "GoogleCloudAiplatformV1beta1CreatePersistentResourceOperationMetadata": { "properties": { "genericMetadata": { "description": "Operation metadata for PersistentResource.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" }, "progressMessage": { "description": "Progress Message for Create LRO", "type": "string" } }, "description": "Details of operations that perform create PersistentResource.", "type": "object", "id": "GoogleCloudAiplatformV1beta1CreatePersistentResourceOperationMetadata" }, "GoogleCloudAiplatformV1beta1QuestionAnsweringCorrectnessSpec": { "description": "Spec for question answering correctness metric.", "properties": { "useReference": { "description": "Optional. Whether to use instance.reference to compute question answering correctness.", "type": "boolean" }, "version": { "type": "integer", "description": "Optional. Which version to use for evaluation.", "format": "int32" } }, "id": "GoogleCloudAiplatformV1beta1QuestionAnsweringCorrectnessSpec", "type": "object" }, "GoogleIamV1SetIamPolicyRequest": { "type": "object", "id": "GoogleIamV1SetIamPolicyRequest", "properties": { "policy": { "$ref": "GoogleIamV1Policy", "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them." } }, "description": "Request message for `SetIamPolicy` method." }, "GenaiVertexV1beta1ToolResultContent": { "type": "object", "id": "GenaiVertexV1beta1ToolResultContent", "properties": { "googleMapsResult": { "$ref": "GenaiVertexV1beta1GoogleMapsResultContent" }, "signature": { "format": "byte", "description": "A signature hash for backend validation.", "type": "string" }, "codeExecutionResult": { "$ref": "GenaiVertexV1beta1CodeExecutionResultContent" }, "mcpServerToolResult": { "$ref": "GenaiVertexV1beta1McpServerToolResultContent" }, "callId": { "type": "string", "description": "Required. ID to match the ID from the function call block." }, "fileSearchResult": { "$ref": "GenaiVertexV1beta1FileSearchResultContent" }, "googleSearchResult": { "$ref": "GenaiVertexV1beta1GoogleSearchResultContent" }, "functionResult": { "$ref": "GenaiVertexV1beta1FunctionResultContent" }, "urlContextResult": { "$ref": "GenaiVertexV1beta1UrlContextResultContent" } }, "description": "Tool result content.", "deprecated": true }, "GoogleCloudAiplatformV1beta1LossAnalysisConfig": { "properties": { "metric": { "description": "Required. The metric to analyze (e.g., \"tool_use_quality\"). This filters the EvaluationItems in the EvalSet to only those where EvaluationResult.metric matches this value.", "type": "string" }, "candidate": { "type": "string", "description": "Required. The candidate model/agent to analyze (e.g., \"gemini-3.0-pro\"). This targets the specific CandidateResult within the EvaluationResult." } }, "id": "GoogleCloudAiplatformV1beta1LossAnalysisConfig", "description": "Configuration for the loss analysis job.", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaTextPromptDatasetMetadata": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaTextPromptDatasetMetadata", "description": "The metadata of Datasets that contain Text Prompt data.", "properties": { "note": { "description": "User-created prompt note. Note size limit is 2KB.", "type": "string" }, "seedEnabled": { "type": "boolean", "description": "Seeding enables model to return a deterministic response on a best effort basis. Determinism isn't guaranteed. This field determines whether or not seeding is enabled." }, "maxOutputTokens": { "description": "Value of the maximum number of tokens generated set when the dataset was saved.", "format": "int64", "type": "string" }, "hasPromptVariable": { "type": "boolean", "description": "Whether the prompt dataset has prompt variable." }, "gcsUri": { "type": "string", "description": "The Google Cloud Storage URI that stores the prompt data." }, "stopSequences": { "type": "array", "description": "Customized stop sequences.", "items": { "type": "string" } }, "temperature": { "format": "float", "type": "number", "description": "Temperature value used for sampling set when the dataset was saved. This value is used to tune the degree of randomness." }, "candidateCount": { "format": "int64", "type": "string", "description": "Number of candidates." }, "groundingConfig": { "$ref": "GoogleCloudAiplatformV1beta1SchemaPredictParamsGroundingConfig", "description": "Grounding checking configuration." }, "promptType": { "description": "Type of the prompt dataset.", "type": "string" }, "systemInstructionGcsUri": { "description": "The Google Cloud Storage URI that stores the system instruction, starting with gs://.", "type": "string" }, "seedValue": { "type": "string", "format": "int64", "description": "The actual value of the seed." }, "systemInstruction": { "type": "string", "description": "The content of the prompt dataset system instruction." }, "text": { "type": "string", "description": "The content of the prompt dataset." }, "logprobs": { "description": "Whether or not the user has enabled logit probabilities in the model parameters.", "type": "boolean" }, "topK": { "type": "string", "format": "int64", "description": "Top K value set when the dataset was saved. This value determines how many candidates with highest probability from the vocab would be selected for each decoding step." }, "promptApiSchema": { "$ref": "GoogleCloudAiplatformV1beta1SchemaPromptApiSchema", "description": "The API schema of the prompt to support both UI and SDK usages." }, "topP": { "type": "number", "format": "float", "description": "Top P value set when the dataset was saved. Given topK tokens for decoding, top candidates will be selected until the sum of their probabilities is topP." } } }, "GoogleCloudAiplatformV1beta1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies": { "id": "GoogleCloudAiplatformV1beta1ModelMonitoringStatsAnomaliesFeatureHistoricStatsAnomalies", "properties": { "trainingStats": { "description": "Stats calculated for the Training Dataset.", "$ref": "GoogleCloudAiplatformV1beta1FeatureStatsAnomaly" }, "featureDisplayName": { "description": "Display Name of the Feature.", "type": "string" }, "predictionStats": { "type": "array", "description": "A list of historical stats generated by different time window's Prediction Dataset.", "items": { "$ref": "GoogleCloudAiplatformV1beta1FeatureStatsAnomaly" } }, "threshold": { "$ref": "GoogleCloudAiplatformV1beta1ThresholdConfig", "description": "Threshold for anomaly detection." } }, "type": "object", "description": "Historical Stats (and Anomalies) for a specific Feature." }, "GoogleCloudAiplatformV1beta1ListA2ATaskRecordEventsResponse": { "description": "Response message for A2ATaskRecordService.ListA2ATaskRecordEvents.", "properties": { "events": { "type": "array", "description": "List of A2ATaskRecordEvents in the requested page.", "items": { "$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordEvent" } }, "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results." } }, "id": "GoogleCloudAiplatformV1beta1ListA2ATaskRecordEventsResponse", "type": "object" }, "GoogleCloudAiplatformV1beta1TranslationConfig": { "type": "object", "id": "GoogleCloudAiplatformV1beta1TranslationConfig", "properties": { "echoTargetLanguage": { "description": "Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language.", "type": "boolean" }, "targetLanguageCode": { "type": "string", "description": "Required. The target language for translation. Supported values are BCP-47 language codes (e.g. \"en\", \"es\", \"fr\")." } }, "description": "Config for translation features." }, "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources": { "properties": { "reviewSnippets": { "items": { "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet" }, "type": "array", "description": "Snippets of reviews that were used to generate the answer." } }, "description": "The sources that were 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.", "type": "object", "id": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources" }, "GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingRankService": { "description": "Config for Rank Service.", "properties": { "modelName": { "type": "string", "description": "Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingRankService" }, "GoogleCloudAiplatformV1beta1AgentConfig": { "type": "object", "id": "GoogleCloudAiplatformV1beta1AgentConfig", "properties": { "agentId": { "description": "Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map.", "type": "string" }, "tools": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Tool" }, "description": "Optional. The list of tools available to this agent.", "type": "array" }, "subAgents": { "description": "Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology.", "items": { "type": "string" }, "type": "array" }, "description": { "type": "string", "description": "Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly." }, "instruction": { "type": "string", "description": "Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field." }, "agentType": { "description": "Optional. The type or class of the agent (e.g., \"LlmAgent\", \"RouterAgent\", \"ToolUseAgent\"). Useful for the autorater to understand the expected behavior of the agent.", "type": "string" } }, "description": "Represents configuration for an Agent." }, "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair": { "type": "object", "description": "Feature name & value pair.", "id": "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair", "properties": { "value": { "description": "Feature value.", "$ref": "GoogleCloudAiplatformV1beta1FeatureValue" }, "name": { "description": "Feature short name.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1QuestionAnsweringRelevanceInput": { "type": "object", "properties": { "instance": { "description": "Required. Question answering relevance instance.", "$ref": "GoogleCloudAiplatformV1beta1QuestionAnsweringRelevanceInstance" }, "metricSpec": { "$ref": "GoogleCloudAiplatformV1beta1QuestionAnsweringRelevanceSpec", "description": "Required. Spec for question answering relevance score metric." } }, "description": "Input for question answering relevance metric.", "id": "GoogleCloudAiplatformV1beta1QuestionAnsweringRelevanceInput" }, "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilitySessionScopePredicate": { "id": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilitySessionScopePredicate", "type": "object", "properties": { "modelCalls": { "description": "Filter on the number of underlying LLM calls within a session.", "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityNumericPredicate" }, "toolCalls": { "description": "Filter on the number of underlying tool calls within a session.", "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityNumericPredicate" }, "duration": { "description": "Filter on the duration of a session (in seconds).", "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityNumericPredicate" }, "modelCallErrors": { "description": "Filter on the number of LLM call errors within a session.", "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityNumericPredicate" }, "totalTokenUsage": { "description": "Filter on the total token usage within a session.", "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityNumericPredicate" }, "toolCallErrors": { "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityNumericPredicate", "description": "Filter on the number of tool call errors within a session." }, "userTurns": { "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityNumericPredicate", "description": "Filter on the number of user turns within a session." } }, "description": "Defines a single filter predicate." }, "GoogleCloudAiplatformV1beta1SchemaPromptSpecAppBuilderData": { "properties": { "deployedRegions": { "type": "array", "description": "Optional. The Cloud Run regions in which the application is currently deployed. Used to rediscover and redeploy the app in the regions it already runs in, which may differ from the prompt's location.", "items": { "type": "string" } }, "codeRepositoryState": { "type": "string", "description": "Serialized state of the code repository. This string will typically contain a JSON representation of the UI's CodeRepositoryService state (files, folders, content, and any metadata). The UI is responsible for serialization and deserialization." }, "framework": { "description": "Optional. Framework used to build the application.", "enumDescriptions": [ "Unspecified framework.", "React framework.", "Angular framework." ], "enum": [ "FRAMEWORK_UNSPECIFIED", "REACT", "ANGULAR" ], "type": "string" }, "linkedResources": { "description": "Linked resources attached to the application by the user.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaPromptSpecAppBuilderDataLinkedResource" } } }, "id": "GoogleCloudAiplatformV1beta1SchemaPromptSpecAppBuilderData", "type": "object", "description": "Defines data for an application builder." }, "GoogleCloudAiplatformV1beta1ProbeHttpGetAction": { "description": "HttpGetAction describes an action based on HTTP Get requests.", "type": "object", "id": "GoogleCloudAiplatformV1beta1ProbeHttpGetAction", "properties": { "port": { "format": "int32", "type": "integer", "description": "Number of the port to access on the container. Number must be in the range 1 to 65535." }, "path": { "type": "string", "description": "Path to access on the HTTP server." }, "scheme": { "description": "Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are \"HTTP\" or \"HTTPS\".", "type": "string" }, "httpHeaders": { "items": { "$ref": "GoogleCloudAiplatformV1beta1ProbeHttpHeader" }, "description": "Custom headers to set in the request. HTTP allows repeated headers.", "type": "array" }, "host": { "description": "Host name to connect to, defaults to the model serving container's IP. You probably want to set \"Host\" in httpHeaders instead.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsTextSentimentEvaluationMetrics": { "type": "object", "description": "Model evaluation metrics for text sentiment problems.", "properties": { "quadraticKappa": { "description": "Quadratic weighted kappa. Only set for ModelEvaluations, not for ModelEvaluationSlices.", "type": "number", "format": "float" }, "meanSquaredError": { "description": "Mean squared error. Only set for ModelEvaluations, not for ModelEvaluationSlices.", "type": "number", "format": "float" }, "recall": { "description": "Recall.", "format": "float", "type": "number" }, "f1Score": { "format": "float", "description": "The harmonic mean of recall and precision.", "type": "number" }, "linearKappa": { "format": "float", "description": "Linear weighted kappa. Only set for ModelEvaluations, not for ModelEvaluationSlices.", "type": "number" }, "confusionMatrix": { "$ref": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsConfusionMatrix", "description": "Confusion matrix of the evaluation. Only set for ModelEvaluations, not for ModelEvaluationSlices." }, "precision": { "type": "number", "format": "float", "description": "Precision." }, "meanAbsoluteError": { "description": "Mean absolute error. Only set for ModelEvaluations, not for ModelEvaluationSlices.", "type": "number", "format": "float" } }, "id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsTextSentimentEvaluationMetrics" }, "GoogleCloudAiplatformV1beta1WorkerPoolSpec": { "type": "object", "id": "GoogleCloudAiplatformV1beta1WorkerPoolSpec", "description": "Represents the spec of a worker pool in a job.", "properties": { "pythonPackageSpec": { "description": "The Python packaged task.", "$ref": "GoogleCloudAiplatformV1beta1PythonPackageSpec" }, "containerSpec": { "$ref": "GoogleCloudAiplatformV1beta1ContainerSpec", "description": "The custom container task." }, "diskSpec": { "description": "Disk spec.", "$ref": "GoogleCloudAiplatformV1beta1DiskSpec" }, "nfsMounts": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1NfsMount" }, "description": "Optional. List of NFS mount spec." }, "lustreMounts": { "items": { "$ref": "GoogleCloudAiplatformV1beta1LustreMount" }, "description": "Optional. List of Lustre mounts.", "type": "array" }, "replicaCount": { "format": "int64", "description": "Optional. The number of worker replicas to use for this worker pool.", "type": "string" }, "machineSpec": { "$ref": "GoogleCloudAiplatformV1beta1MachineSpec", "description": "Optional. Immutable. The specification of a single machine." } } }, "GoogleCloudAiplatformV1beta1FractionSplit": { "type": "object", "description": "Assigns the input data to training, validation, and test sets as per the given fractions. Any of `training_fraction`, `validation_fraction` and `test_fraction` may optionally be provided, they must sum to up to 1. If the provided ones sum to less than 1, the remainder is assigned to sets as decided by Vertex AI. If none of the fractions are set, by default roughly 80% of data is used for training, 10% for validation, and 10% for test.", "id": "GoogleCloudAiplatformV1beta1FractionSplit", "properties": { "testFraction": { "type": "number", "description": "The fraction of the input data that is to be used to evaluate the Model.", "format": "double" }, "trainingFraction": { "description": "The fraction of the input data that is to be used to train the Model.", "type": "number", "format": "double" }, "validationFraction": { "description": "The fraction of the input data that is to be used to validate the Model.", "format": "double", "type": "number" } } }, "GoogleCloudAiplatformV1beta1FeatureNoiseSigma": { "id": "GoogleCloudAiplatformV1beta1FeatureNoiseSigma", "type": "object", "properties": { "noiseSigma": { "description": "Noise sigma per feature. No noise is added to features that are not set.", "items": { "$ref": "GoogleCloudAiplatformV1beta1FeatureNoiseSigmaNoiseSigmaForFeature" }, "type": "array" } }, "description": "Noise sigma by features. Noise sigma represents the standard deviation of the gaussian kernel that will be used to add noise to interpolated inputs prior to computing gradients." }, "GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig": { "id": "GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig", "description": "A set of Shielded VM options for the execution VM. Mirrors `google.cloud.notebooks.v2.ShieldedInstanceConfig`. See https://cloud.google.com/compute/docs/instances/modifying-shielded-vm.", "properties": { "enableSecureBoot": { "description": "Optional. Whether the VM instance has Secure Boot enabled. Disabled by default.", "type": "boolean" }, "enableVtpm": { "description": "Optional. Whether the VM instance has vTPM enabled.", "type": "boolean" }, "enableIntegrityMonitoring": { "description": "Optional. Whether the VM instance has integrity monitoring enabled.", "type": "boolean" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1LossCluster": { "type": "object", "description": "Represents a semantic grouping of failures (e.g., \"Hallucination of Action\").", "properties": { "taxonomyEntry": { "$ref": "GoogleCloudAiplatformV1beta1LossTaxonomyEntry", "description": "The structured definition of the loss taxonomy for this cluster." }, "itemCount": { "description": "The total number of EvaluationItems falling into this cluster.", "format": "int32", "type": "integer" }, "clusterId": { "description": "Unique identifier for the loss cluster within the scope of the analysis result.", "type": "string" }, "examples": { "description": "A list of examples that belong to this cluster. This links the cluster back to the specific EvaluationItems and Rubrics.", "items": { "$ref": "GoogleCloudAiplatformV1beta1LossExample" }, "type": "array" } }, "id": "GoogleCloudAiplatformV1beta1LossCluster" }, "GoogleCloudAiplatformV1beta1ExecuteCodeRequest": { "id": "GoogleCloudAiplatformV1beta1ExecuteCodeRequest", "type": "object", "properties": { "inputs": { "description": "Required. The inputs used for the stateless code execution.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Chunk" } } }, "description": "Request message for SandboxEnvironmentExecutionService.ExecuteCode." }, "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline": { "description": "Output from BatchPredictionJob for Model Monitoring baseline dataset, which can be used to generate baseline attribution scores.", "properties": { "bigquery": { "description": "BigQuery location for BatchExplain output.", "$ref": "GoogleCloudAiplatformV1beta1BigQueryDestination" }, "gcs": { "$ref": "GoogleCloudAiplatformV1beta1GcsDestination", "description": "Cloud Storage location for BatchExplain output." }, "predictionFormat": { "enum": [ "PREDICTION_FORMAT_UNSPECIFIED", "JSONL", "BIGQUERY" ], "description": "The storage format of the predictions generated BatchPrediction job.", "type": "string", "enumDescriptions": [ "Should not be set.", "Predictions are in JSONL files.", "Predictions are in BigQuery." ] } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveConfigExplanationConfigExplanationBaseline" }, "GoogleCloudAiplatformV1beta1ExternalApiElasticSearchParams": { "id": "GoogleCloudAiplatformV1beta1ExternalApiElasticSearchParams", "description": "The search parameters to use for the ELASTIC_SEARCH spec.", "type": "object", "properties": { "searchTemplate": { "description": "The ElasticSearch search template to use.", "type": "string" }, "index": { "type": "string", "description": "The ElasticSearch index to use." }, "numHits": { "type": "integer", "format": "int32", "description": "Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param." } } }, "CloudAiLargeModelsVisionGenerateVideoExperimentsVESchedulingConfig": { "description": "Scheduling configuration for Veo Experimental.", "properties": { "enableRetry": { "description": "Optional. If true, enable retries on transient errors with default backoff.", "type": "boolean" } }, "type": "object", "id": "CloudAiLargeModelsVisionGenerateVideoExperimentsVESchedulingConfig" }, "GoogleCloudAiplatformV1beta1DeployedModel": { "type": "object", "description": "A deployment of a Model. Endpoints contain one or more DeployedModels.", "id": "GoogleCloudAiplatformV1beta1DeployedModel", "properties": { "enableAccessLogging": { "description": "If true, online prediction access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each prediction request. Note that logs may incur a cost, especially if your project receives prediction requests at a high queries per second rate (QPS). Estimate your costs before enabling this option.", "type": "boolean" }, "rolloutOptions": { "description": "Options for configuring rolling deployments.", "$ref": "GoogleCloudAiplatformV1beta1RolloutOptions" }, "checkpointId": { "description": "The checkpoint id of the model.", "type": "string" }, "gdcConnectedModel": { "description": "GDC pretrained / Gemini model name. The model name is a plain model name, e.g. gemini-1.5-flash-002.", "type": "string" }, "createTime": { "type": "string", "description": "Output only. Timestamp when the DeployedModel was created.", "readOnly": true, "format": "google-datetime" }, "speculativeDecodingSpec": { "description": "Optional. Spec for configuring speculative decoding.", "$ref": "GoogleCloudAiplatformV1beta1SpeculativeDecodingSpec" }, "disableExplanations": { "description": "If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec.", "type": "boolean" }, "fasterDeploymentConfig": { "description": "Configuration for faster model deployment.", "$ref": "GoogleCloudAiplatformV1beta1FasterDeploymentConfig" }, "modelVersionId": { "type": "string", "description": "Output only. The version ID of the model that is deployed.", "readOnly": true }, "serviceAccount": { "type": "string", "description": "The service account that the DeployedModel's container runs as. Specify the email address of the service account. If this service account is not specified, the container runs as a service account that doesn't have access to the resource project. Users deploying the Model must have the `iam.serviceAccounts.actAs` permission on this service account." }, "status": { "description": "Output only. Runtime status of the deployed model.", "$ref": "GoogleCloudAiplatformV1beta1DeployedModelStatus", "readOnly": true }, "explanationSpec": { "$ref": "GoogleCloudAiplatformV1beta1ExplanationSpec", "description": "Explanation configuration for this DeployedModel. When deploying a Model using EndpointService.DeployModel, this value overrides the value of Model.explanation_spec. All fields of explanation_spec are optional in the request. If a field of explanation_spec is not populated, the value of the same field of Model.explanation_spec is inherited. If the corresponding Model.explanation_spec is not populated, all fields of the explanation_spec will be used for the explanation configuration." }, "enableContainerLogging": { "description": "If true, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging. Only supported for custom-trained Models and AutoML Tabular Models.", "type": "boolean" }, "id": { "type": "string", "description": "Immutable. The ID of the DeployedModel. If not provided upon deployment, Vertex AI will generate a value for this ID. This value should be 1-10 characters, and valid characters are `/[0-9]/`." }, "displayName": { "type": "string", "description": "The display name of the DeployedModel. If not provided upon creation, the Model's display_name is used." }, "fullFineTunedResources": { "$ref": "GoogleCloudAiplatformV1beta1FullFineTunedResources", "description": "Optional. Resources for a full fine tuned model." }, "disableContainerLogging": { "type": "boolean", "description": "For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true." }, "model": { "type": "string", "description": "The resource name of the Model that this is the deployment of. Note that the Model may be in a different location than the DeployedModel's Endpoint. The resource name may contain version id or version alias to specify the version. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` if no version is specified, the default version will be deployed." }, "sharedResources": { "type": "string", "description": "The resource name of the shared DeploymentResourcePool to deploy on. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`" }, "automaticResources": { "description": "A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.", "$ref": "GoogleCloudAiplatformV1beta1AutomaticResources" }, "systemLabels": { "additionalProperties": { "type": "string" }, "type": "object", "description": "System labels to apply to Model Garden deployments. System labels are managed by Google for internal use only." }, "privateEndpoints": { "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1PrivateEndpoints", "description": "Output only. Provide paths for users to send predict/explain/health requests directly to the deployed model services running on Cloud via private services access. This field is populated if network is configured." }, "dedicatedResources": { "description": "A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration.", "$ref": "GoogleCloudAiplatformV1beta1DedicatedResources" } } }, "GoogleCloudAiplatformV1beta1BatchPredictionJob": { "properties": { "model": { "type": "string", "description": "The name of the Model resource that produces the predictions via this job, must share the same ancestor Location. Starting this job has no impact on any existing deployments of the Model and their resources. Exactly one of model, unmanaged_container_model, or endpoint must be set. The model resource name may contain version id or version alias to specify the version. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` if no version is specified, the default version will be deployed. The model resource could also be a publisher model. Example: `publishers/{publisher}/models/{model}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`" }, "inputConfig": { "description": "Required. Input configuration of the instances on which predictions are performed. The schema of any single instance may be specified via the Model's PredictSchemata's instance_schema_uri.", "$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJobInputConfig" }, "modelMonitoringConfig": { "description": "Model monitoring config will be used for analysis model behaviors, based on the input and output to the batch prediction job, as well as the provided training dataset.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringConfig" }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" }, "disableContainerLogging": { "type": "boolean", "description": "For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true." }, "instanceConfig": { "$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJobInstanceConfig", "description": "Configuration for how to convert batch prediction input instances to the prediction instances that are sent to the Model." }, "completionStats": { "description": "Output only. Statistics on completed and failed prediction instances.", "$ref": "GoogleCloudAiplatformV1beta1CompletionStats", "readOnly": true }, "createTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. Time when the BatchPredictionJob was created." }, "modelMonitoringStatus": { "$ref": "GoogleRpcStatus", "readOnly": true, "description": "Output only. The running status of the model monitoring pipeline." }, "outputConfig": { "description": "Required. The Configuration specifying where output predictions should be written. The schema of any single prediction may be specified as a concatenation of Model's PredictSchemata's instance_schema_uri and prediction_schema_uri.", "$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJobOutputConfig" }, "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Time when the BatchPredictionJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`." }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Time when the BatchPredictionJob was most recently updated.", "type": "string" }, "endpoint": { "type": "string", "description": "For Bring-Your-Own-Endpoint (BYOE), the name of the Endpoint resource that produces the predictions via this job, must share the same ancestor Location. Exactly one of model, unmanaged_container_model, or endpoint must be set. Example: `projects/193595526740/locations/us-central1/endpoints/4203439000301600768`" }, "startTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. Time when the BatchPredictionJob for the first time entered the `JOB_STATE_RUNNING` state." }, "partialFailures": { "description": "Output only. Partial failures encountered. For example, single files that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details.", "type": "array", "readOnly": true, "items": { "$ref": "GoogleRpcStatus" } }, "unmanagedContainerModel": { "$ref": "GoogleCloudAiplatformV1beta1UnmanagedContainerModel", "description": "Contains model information necessary to perform batch prediction without requiring uploading to model registry. Exactly one of model, unmanaged_container_model, or endpoint must be set." }, "name": { "description": "Output only. Resource name of the BatchPredictionJob.", "type": "string", "readOnly": true }, "error": { "description": "Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.", "$ref": "GoogleRpcStatus", "readOnly": true }, "serviceAccount": { "description": "The service account that the DeployedModel's container runs as. If not specified, a system generated one will be used, which has minimal permissions and the custom container, if used, may not have enough permission to access other Google Cloud resources. Users deploying the Model must have the `iam.serviceAccounts.actAs` permission on this service account.", "type": "string" }, "modelVersionId": { "description": "Output only. The version ID of the Model that produces the predictions via this job.", "readOnly": true, "type": "string" }, "resourcesConsumed": { "description": "Output only. Information about resources that had been consumed by this job. Provided in real time at best effort basis, as well as a final value once the job completes. Note: This field currently may be not populated for batch predictions that use AutoML Models.", "$ref": "GoogleCloudAiplatformV1beta1ResourcesConsumed", "readOnly": true }, "displayName": { "description": "Required. The user-defined name of this BatchPredictionJob.", "type": "string" }, "encryptionSpec": { "description": "Customer-managed encryption key options for a BatchPredictionJob. If this is set, then all resources created by the BatchPredictionJob will be encrypted with the provided encryption key.", "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec" }, "dedicatedResources": { "$ref": "GoogleCloudAiplatformV1beta1BatchDedicatedResources", "description": "The config of resources used by the Model during the batch prediction. If the Model supports DEDICATED_RESOURCES this config may be provided (and the job will use these resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config must be provided." }, "state": { "type": "string", "enumDescriptions": [ "The job state is unspecified.", "The job has been just created or resumed and processing has not yet begun.", "The service is preparing to run the job.", "The job is in progress.", "The job completed successfully.", "The job failed.", "The job is being cancelled. From this state the job may only go to either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.", "The job has been cancelled.", "The job has been stopped, and can be resumed.", "The job has expired.", "The job is being updated. Only jobs in the `RUNNING` state can be updated. After updating, the job goes back to the `RUNNING` state.", "The job is partially succeeded, some results may be missing due to errors." ], "description": "Output only. The detailed state of the job.", "enum": [ "JOB_STATE_UNSPECIFIED", "JOB_STATE_QUEUED", "JOB_STATE_PENDING", "JOB_STATE_RUNNING", "JOB_STATE_SUCCEEDED", "JOB_STATE_FAILED", "JOB_STATE_CANCELLING", "JOB_STATE_CANCELLED", "JOB_STATE_PAUSED", "JOB_STATE_EXPIRED", "JOB_STATE_UPDATING", "JOB_STATE_PARTIALLY_SUCCEEDED" ], "readOnly": true }, "explanationSpec": { "$ref": "GoogleCloudAiplatformV1beta1ExplanationSpec", "description": "Explanation configuration for this BatchPredictionJob. Can be specified only if generate_explanation is set to `true`. This value overrides the value of Model.explanation_spec. All fields of explanation_spec are optional in the request. If a field of the explanation_spec object is not populated, the corresponding field of the Model.explanation_spec object is inherited." }, "generateExplanation": { "type": "boolean", "description": "Generate explanation with the batch prediction results. When set to `true`, the batch prediction output changes based on the `predictions_format` field of the BatchPredictionJob.output_config object: * `bigquery`: output includes a column named `explanation`. The value is a struct that conforms to the Explanation object. * `jsonl`: The JSON objects on each line include an additional entry keyed `explanation`. The value of the entry is a JSON object that conforms to the Explanation object. * `csv`: Generating explanations for CSV format is not supported. If this field is set to true, either the Model.explanation_spec or explanation_spec must be populated." }, "outputInfo": { "description": "Output only. Information further describing the output of this job.", "$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJobOutputInfo", "readOnly": true }, "manualBatchTuningParameters": { "description": "Immutable. Parameters configuring the batch behavior. Currently only applicable when dedicated_resources are used (in other cases Vertex AI does the tuning itself).", "$ref": "GoogleCloudAiplatformV1beta1ManualBatchTuningParameters" }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "type": "boolean", "readOnly": true }, "labels": { "description": "The labels with user-defined metadata to organize BatchPredictionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.", "additionalProperties": { "type": "string" }, "type": "object" }, "modelParameters": { "description": "The parameters that govern the predictions. The schema of the parameters may be specified via the Model's PredictSchemata's parameters_schema_uri.", "type": "any" }, "modelMonitoringStatsAnomalies": { "description": "Get batch prediction job monitoring statistics.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringStatsAnomalies" }, "type": "array" } }, "type": "object", "description": "A job that uses a Model to produce predictions on multiple input instances. If predictions for significant portion of the instances fail, the job may finish without attempting predictions for all remaining instances.", "id": "GoogleCloudAiplatformV1beta1BatchPredictionJob" }, "GoogleCloudAiplatformV1beta1Checkpoint": { "id": "GoogleCloudAiplatformV1beta1Checkpoint", "type": "object", "properties": { "step": { "type": "string", "description": "The step of the checkpoint.", "format": "int64" }, "epoch": { "format": "int64", "description": "The epoch of the checkpoint.", "type": "string" }, "checkpointId": { "description": "The ID of the checkpoint.", "type": "string" } }, "description": "Describes the machine learning model version checkpoint." }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecasting": { "type": "object", "properties": { "inputs": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingInputs", "description": "The input parameters of this TrainingJob." }, "metadata": { "description": "The metadata information.", "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingMetadata" } }, "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecasting", "description": "A TrainingJob that trains and uploads an AutoML Forecasting Model." }, "GoogleCloudAiplatformV1beta1UrlContextMetadata": { "properties": { "urlMetadata": { "items": { "$ref": "GoogleCloudAiplatformV1beta1UrlMetadata" }, "type": "array", "readOnly": true, "description": "Output only. A list of URL metadata, with one entry for each URL retrieved by the tool." } }, "description": "Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.", "type": "object", "id": "GoogleCloudAiplatformV1beta1UrlContextMetadata" }, "GenaiVertexV1beta1ContentDeltaData": { "type": "object", "id": "GenaiVertexV1beta1ContentDeltaData", "description": "The delta content data for a content block.", "properties": { "thoughtSignature": { "$ref": "GenaiVertexV1beta1ThoughtSignatureDelta" }, "thoughtSummary": { "$ref": "GenaiVertexV1beta1ThoughtSummaryDelta" }, "image": { "$ref": "GenaiVertexV1beta1ImageDelta" }, "audio": { "$ref": "GenaiVertexV1beta1AudioDelta" }, "textAnnotation": { "$ref": "GenaiVertexV1beta1TextAnnotationDelta" }, "toolResult": { "$ref": "GenaiVertexV1beta1ToolResultDelta" }, "document": { "$ref": "GenaiVertexV1beta1DocumentDelta" }, "toolCall": { "$ref": "GenaiVertexV1beta1ToolCallDelta" }, "text": { "$ref": "GenaiVertexV1beta1TextDelta" }, "video": { "$ref": "GenaiVertexV1beta1VideoDelta" } } }, "GoogleCloudAiplatformV1beta1RaySpec": { "properties": { "imageUri": { "type": "string", "description": "Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field." }, "rayClusterAutoscalingSpec": { "description": "Optional. Optional Ray autoscaling configurations.", "$ref": "GoogleCloudAiplatformV1beta1RayClusterAutoscalingSpec" }, "rayMetricSpec": { "$ref": "GoogleCloudAiplatformV1beta1RayMetricSpec", "description": "Optional. Ray metrics configurations." }, "rayLogsSpec": { "description": "Optional. OSS Ray logging configurations.", "$ref": "GoogleCloudAiplatformV1beta1RayLogsSpec" }, "nfsMounts": { "type": "array", "description": "Optional. Use if you want to mount to any NFS storages.", "items": { "$ref": "GoogleCloudAiplatformV1beta1NfsMount" } }, "headNodeResourcePoolId": { "description": "Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set.", "type": "string" }, "resourcePoolImages": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Optional. Required if image_uri isn't set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids. Example: { \"ray_head_node_pool\": \"head image\" \"ray_worker_node_pool1\": \"worker image\" \"ray_worker_node_pool2\": \"another worker image\" }" } }, "type": "object", "description": "Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes.", "id": "GoogleCloudAiplatformV1beta1RaySpec" }, "GoogleCloudAiplatformV1beta1TrajectoryPrecisionInstance": { "properties": { "referenceTrajectory": { "description": "Required. Spec for reference tool call trajectory.", "$ref": "GoogleCloudAiplatformV1beta1Trajectory" }, "predictedTrajectory": { "description": "Required. Spec for predicted tool call trajectory.", "$ref": "GoogleCloudAiplatformV1beta1Trajectory" } }, "id": "GoogleCloudAiplatformV1beta1TrajectoryPrecisionInstance", "type": "object", "description": "Spec for TrajectoryPrecision instance." }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingMetadata": { "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlForecastingMetadata", "properties": { "evaluatedDataItemsBigqueryUri": { "type": "string", "description": "BigQuery destination uri for exported evaluated examples." }, "trainCostMilliNodeHours": { "format": "int64", "type": "string", "description": "Output only. The actual training cost of the model, expressed in milli node hours, i.e. 1,000 value in this field means 1 node hour. Guaranteed to not exceed the train budget." } }, "type": "object", "description": "Model metadata specific to AutoML Forecasting." }, "GenaiVertexV1beta1FunctionResultSubcontent": { "id": "GenaiVertexV1beta1FunctionResultSubcontent", "type": "object", "properties": { "image": { "$ref": "GenaiVertexV1beta1ImageContent" }, "text": { "$ref": "GenaiVertexV1beta1TextContent" } } }, "GoogleCloudAiplatformV1beta1BatchReadFeatureValuesRequestEntityTypeSpec": { "id": "GoogleCloudAiplatformV1beta1BatchReadFeatureValuesRequestEntityTypeSpec", "properties": { "settings": { "items": { "$ref": "GoogleCloudAiplatformV1beta1DestinationFeatureSetting" }, "type": "array", "description": "Per-Feature settings for the batch read." }, "entityTypeId": { "description": "Required. ID of the EntityType to select Features. The EntityType id is the entity_type_id specified during EntityType creation.", "type": "string" }, "featureSelector": { "description": "Required. Selectors choosing which Feature values to read from the EntityType.", "$ref": "GoogleCloudAiplatformV1beta1FeatureSelector" } }, "description": "Selects Features of an EntityType to read values of and specifies read settings.", "type": "object" }, "GoogleCloudAiplatformV1beta1FunctionCall": { "id": "GoogleCloudAiplatformV1beta1FunctionCall", "properties": { "id": { "description": "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`.", "type": "string" }, "name": { "description": "Optional. The name of the function to call. Matches FunctionDeclaration.name.", "type": "string" }, "willContinue": { "description": "Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.", "type": "boolean" }, "args": { "description": "Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details.", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "partialArgs": { "type": "array", "description": "Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.", "items": { "$ref": "GoogleCloudAiplatformV1beta1PartialArg" } } }, "description": "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.", "type": "object" }, "GoogleCloudAiplatformV1beta1QuestionAnsweringHelpfulnessResult": { "properties": { "explanation": { "description": "Output only. Explanation for question answering helpfulness score.", "readOnly": true, "type": "string" }, "score": { "type": "number", "readOnly": true, "description": "Output only. Question Answering Helpfulness score.", "format": "float" }, "confidence": { "type": "number", "description": "Output only. Confidence for question answering helpfulness score.", "format": "float", "readOnly": true } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1QuestionAnsweringHelpfulnessResult", "description": "Spec for question answering helpfulness result." }, "GoogleCloudAiplatformV1beta1DeployPublisherModelRequest": { "id": "GoogleCloudAiplatformV1beta1DeployPublisherModelRequest", "properties": { "endpointDisplayName": { "description": "Optional. The user-specified display name of the endpoint. If not set, a default name will be used.", "type": "string" }, "acceptEula": { "description": "Optional. Whether the user accepts the End User License Agreement (EULA) for the model.", "type": "boolean" }, "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://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" }, "huggingFaceAccessToken": { "description": "Optional. The Hugging Face read access token used to access the model artifacts of gated models.", "type": "string" }, "dedicatedResources": { "description": "Optional. The dedicated resources to use for the endpoint. If not set, the default resources will be used.", "$ref": "GoogleCloudAiplatformV1beta1DedicatedResources" } }, "description": "Request message for ModelGardenService.DeployPublisherModel.", "deprecated": true, "type": "object" }, "GoogleCloudAiplatformV1beta1EvaluationRequest": { "type": "object", "properties": { "rubrics": { "description": "Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1RubricGroup" } }, "prompt": { "description": "Optional. The request/prompt to evaluate.", "$ref": "GoogleCloudAiplatformV1beta1EvaluationPrompt" }, "candidateResponses": { "description": "Optional. Responses from model under test and other baseline models for comparison.", "items": { "$ref": "GoogleCloudAiplatformV1beta1CandidateResponse" }, "type": "array" }, "goldenResponse": { "$ref": "GoogleCloudAiplatformV1beta1CandidateResponse", "description": "Optional. The Ideal response or ground truth." } }, "description": "A single evaluation request supporting input for both single-turn model generation and multi-turn agent execution traces. Valid input modes: 1. Inference Mode: `prompt` is set (containing text or AgentData context). 2. Offline Eval Mode: `prompt` is unset, and `candidate_responses` contains `agent_data` (the completed execution trace). Validation Rule: Either `prompt` must be set, OR at least one of the `candidate_responses` must contain `agent_data`.", "id": "GoogleCloudAiplatformV1beta1EvaluationRequest" }, "GoogleCloudAiplatformV1beta1AnalyzedSession": { "type": "object", "description": "Represents an analyzed session for a monitored agent.", "properties": { "agentType": { "description": "Output only. The runtime that the agent which ran this session is hosted on (for example, `CLOUD_RUN_SERVICE`). `AGENT_TYPE_UNSPECIFIED` means the runtime is unknown to this service -- the agent is not enrolled as a `MonitoredAgent`, or was enrolled before its runtime was recorded. That is distinct from `AGENT_TYPE_OTHER`, which means the runtime is known and is not one of the enumerated Google Cloud runtimes.", "enum": [ "AGENT_TYPE_UNSPECIFIED", "REASONING_ENGINE", "CLOUD_RUN_SERVICE", "GKE_WORKLOAD", "GCE_INSTANCE", "AGENT_TYPE_OTHER" ], "enumDescriptions": [ "The default value, used when the runtime type is unspecified.", "The agent runs on the Gemini Enterprise Agent Platform Agent Runtime (Reasoning Engine).", "The agent runs as a Google Cloud Run service.", "The agent runs as a workload on Google Kubernetes Engine.", "The agent runs on a Compute Engine instance.", "The agent runs on another runtime, such as a self-hosted, on-premises, or non-Google Cloud environment, or any runtime not represented by the values above." ], "type": "string", "readOnly": true }, "agentDisplayName": { "type": "string", "description": "Output only. The human-readable display name of the MonitoredAgent that owns this session. May be empty when the session's agent is not enrolled as a MonitoredAgent; the `agent_resource_name` is always present and can be used as a fallback identifier.", "readOnly": true }, "createTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. The creation time of the session." }, "sessionState": { "type": "string", "description": "Output only. The state of the session.", "readOnly": true, "enum": [ "SESSION_STATE_UNSPECIFIED", "SESSION_STATE_UNANALYZED", "SESSION_STATE_NOT_FLAGGED", "SESSION_STATE_FLAGGED", "SESSION_STATE_LLM_UNFLAGGED" ], "enumDescriptions": [ "The session state is unspecified.", "The session has not yet been analyzed.", "The session has been analyzed and no anomalies were flagged.", "The session has been analyzed and at least one anomaly was flagged.", "The session was analyzed by the LLM judge, which did not flag any anomalies." ] }, "latestAnalyzedTime": { "readOnly": true, "type": "string", "description": "Output only. The latest analyzed time of the session.", "format": "google-datetime" }, "agentState": { "enum": [ "ENABLEMENT_STATE_UNSPECIFIED", "ACTIVE", "ENABLING", "DISABLED" ], "enumDescriptions": [ "The default value. This value is used if the state is omitted.", "The agent is successfully enabled and active.", "The agent is in the process of being enabled.", "The agent is disabled." ], "type": "string", "readOnly": true, "description": "Output only. The current enablement state of the MonitoredAgent that owns this session (for example, ACTIVE, DISABLED, or ENABLING). Defaults to ENABLEMENT_STATE_UNSPECIFIED when the agent is not enrolled or its state is unknown." }, "sessionId": { "type": "string", "readOnly": true, "description": "Output only. The session ID." }, "agentResourceName": { "description": "Output only. The resource name or identifier of the agent that ran this session. Matches `AgentResource.agent` on the corresponding `MonitoredAgent`, so the format depends on that agent's `AgentResource.agent_type`: * `REASONING_ENGINE`: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` * `CLOUD_RUN_SERVICE`, `GKE_WORKLOAD`, `GCE_INSTANCE`: the resource name of the agent's runtime. * `AGENT_TYPE_OTHER`: a stable identifier for the agent.", "readOnly": true, "type": "string" }, "location": { "description": "Output only. The Google Cloud location (region) of the agent that ran this session (for example, `us-central1`). Empty when the agent is not enrolled or its location is unknown.", "readOnly": true, "type": "string" }, "userId": { "description": "Output only. The user ID.", "readOnly": true, "type": "string" }, "assessment": { "$ref": "GoogleCloudAiplatformV1beta1Assessment", "description": "Output only. Overall security assessment. Populated only in FULL view.", "readOnly": true }, "name": { "description": "Identifier. The resource name of the AnalyzedSession.", "type": "string" }, "severities": { "description": "Output only. Map of severity counts for listing analyzed sessions. The key is the string representation of Severity. Populated in BASIC view only.", "type": "object", "readOnly": true, "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary" } } }, "id": "GoogleCloudAiplatformV1beta1AnalyzedSession" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingInputs": { "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingInputs", "properties": { "timeSeriesIdentifierColumn": { "description": "The name of the column that identifies the time series.", "type": "string" }, "transformations": { "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingInputsTransformation" }, "description": "Each transformation will apply transform function to given input column. And the result will be used for training. When creating transformation for BigQuery Struct column, the column should be flattened using \".\" as the delimiter.", "type": "array" }, "hierarchyConfig": { "description": "Configuration that defines the hierarchical relationship of time series and parameters for hierarchical forecasting strategies.", "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionHierarchyConfig" }, "unavailableAtForecastColumns": { "items": { "type": "string" }, "description": "Names of columns that are unavailable when a forecast is requested. This column contains information for the given entity (identified by the time_series_identifier_column) that is unknown before the forecast For example, actual weather on a given day.", "type": "array" }, "forecastHorizon": { "type": "string", "format": "int64", "description": "The amount of time into the future for which forecasted values for the target are returned. Expressed in number of units defined by the `data_granularity` field." }, "weightColumn": { "description": "Column name that should be used as the weight column. Higher values in this column give more importance to the row during model training. The column must have numeric values between 0 and 10000 inclusively; 0 means the row is ignored for training. If weight column field is not set, then all rows are assumed to have equal weight of 1. This column must be available at forecast.", "type": "string" }, "additionalExperiments": { "items": { "type": "string" }, "description": "Additional experiment flags for the time series forcasting training.", "type": "array" }, "trainBudgetMilliNodeHours": { "format": "int64", "description": "Required. The train budget of creating this model, expressed in milli node hours i.e. 1,000 value in this field means 1 node hour. The training cost of the model will not exceed this budget. The final cost will be attempted to be close to the budget, though may end up being (even) noticeably smaller - at the backend's discretion. This especially may happen when further model training ceases to provide any improvements. If the budget is set to a value known to be insufficient to train a model for the given dataset, the training won't be attempted and will error. The train budget must be between 1,000 and 72,000 milli node hours, inclusive.", "type": "string" }, "windowConfig": { "description": "Config containing strategy for generating sliding windows.", "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionWindowConfig" }, "optimizationObjective": { "type": "string", "description": "Objective function the model is optimizing towards. The training process creates a model that optimizes the value of the objective function over the validation set. The supported optimization objectives: * \"minimize-rmse\" (default) - Minimize root-mean-squared error (RMSE). * \"minimize-mae\" - Minimize mean-absolute error (MAE). * \"minimize-rmsle\" - Minimize root-mean-squared log error (RMSLE). * \"minimize-rmspe\" - Minimize root-mean-squared percentage error (RMSPE). * \"minimize-wape-mae\" - Minimize the combination of weighted absolute percentage error (WAPE) and mean-absolute-error (MAE). * \"minimize-quantile-loss\" - Minimize the quantile loss at the quantiles defined in `quantiles`. * \"minimize-mape\" - Minimize the mean absolute percentage error." }, "validationOptions": { "type": "string", "description": "Validation options for the data validation component. The available options are: * \"fail-pipeline\" - default, will validate against the validation and fail the pipeline if it fails. * \"ignore-validation\" - ignore the results of the validation and continue" }, "targetColumn": { "description": "The name of the column that the Model is to predict values for. This column must be unavailable at forecast.", "type": "string" }, "timeSeriesAttributeColumns": { "description": "Column names that should be used as attribute columns. The value of these columns does not vary as a function of time. For example, store ID or item color.", "items": { "type": "string" }, "type": "array" }, "holidayRegions": { "items": { "type": "string" }, "type": "array", "description": "The geographical region based on which the holiday effect is applied in modeling by adding holiday categorical array feature that include all holidays matching the date. This option only allowed when data_granularity is day. By default, holiday effect modeling is disabled. To turn it on, specify the holiday region using this option." }, "dataGranularity": { "description": "Expected difference in time granularity between rows in the data.", "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingInputsGranularity" }, "timeColumn": { "description": "The name of the column that identifies time order in the time series. This column must be available at forecast.", "type": "string" }, "contextWindow": { "description": "The amount of time into the past training and prediction data is used for model training and prediction respectively. Expressed in number of units defined by the `data_granularity` field.", "format": "int64", "type": "string" }, "exportEvaluatedDataItemsConfig": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionExportEvaluatedDataItemsConfig", "description": "Configuration for exporting test set predictions to a BigQuery table. If this configuration is absent, then the export is not performed." }, "availableAtForecastColumns": { "items": { "type": "string" }, "description": "Names of columns that are available and provided when a forecast is requested. These columns contain information for the given entity (identified by the time_series_identifier_column column) that is known at forecast. For example, predicted weather for a specific day.", "type": "array" }, "quantiles": { "items": { "type": "number", "format": "double" }, "description": "Quantiles to use for minimize-quantile-loss `optimization_objective`. Up to 5 quantiles are allowed of values between 0 and 1, exclusive. Required if the value of optimization_objective is minimize-quantile-loss. Represents the percent quantiles to use for that objective. Quantiles must be unique.", "type": "array" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1CreateNotebookRuntimeTemplateOperationMetadata": { "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "The operation generic information." } }, "id": "GoogleCloudAiplatformV1beta1CreateNotebookRuntimeTemplateOperationMetadata", "type": "object", "description": "Metadata information for NotebookService.CreateNotebookRuntimeTemplate." }, "GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponse": { "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "summary": { "description": "Overall summary across every MonitoredAgent included in the response.", "$ref": "GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary" }, "agentAggregates": { "type": "array", "description": "Aggregated statistics — exactly one entry per unique MonitoredAgent matched by the request.", "items": { "$ref": "GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate" } } }, "description": "Contains aggregated AnalyzedSession statistics, grouped by MonitoredAgent.", "id": "GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponse" }, "GoogleCloudAiplatformV1beta1ListMetadataSchemasResponse": { "properties": { "metadataSchemas": { "items": { "$ref": "GoogleCloudAiplatformV1beta1MetadataSchema" }, "description": "The MetadataSchemas found for the MetadataStore.", "type": "array" }, "nextPageToken": { "type": "string", "description": "A token, which can be sent as ListMetadataSchemasRequest.page_token to retrieve the next page. If this field is not populated, there are no subsequent pages." } }, "description": "Response message for MetadataService.ListMetadataSchemas.", "id": "GoogleCloudAiplatformV1beta1ListMetadataSchemasResponse", "type": "object" }, "GoogleCloudAiplatformV1beta1UploadRagFileRequest": { "id": "GoogleCloudAiplatformV1beta1UploadRagFileRequest", "type": "object", "description": "Request message for VertexRagDataService.UploadRagFile.", "properties": { "ragFile": { "description": "Required. The RagFile to upload.", "$ref": "GoogleCloudAiplatformV1beta1RagFile" }, "uploadRagFileConfig": { "description": "Required. The config for the RagFiles to be uploaded into the RagCorpus. VertexRagDataService.UploadRagFile.", "$ref": "GoogleCloudAiplatformV1beta1UploadRagFileConfig" } } }, "GenaiVertexV1beta1ImageContent": { "properties": { "data": { "description": "The image content.", "type": "string", "format": "byte" }, "resolution": { "enumDescriptions": [ "Default value. This value is unused.", "Low resolution.", "Medium resolution.", "High resolution.", "Ultra high resolution." ], "description": "The resolution of the media.", "type": "string", "enum": [ "MEDIA_RESOLUTION_UNSPECIFIED", "LOW", "MEDIUM", "HIGH", "ULTRA_HIGH" ] }, "mimeTypeString": { "type": "string", "description": "Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the \"mime_type\" JSON key." }, "uri": { "type": "string", "description": "The URI of the image." } }, "id": "GenaiVertexV1beta1ImageContent", "type": "object", "description": "An image content block. " }, "GoogleCloudAiplatformV1beta1ImportRagFilesConfig": { "id": "GoogleCloudAiplatformV1beta1ImportRagFilesConfig", "properties": { "rebuildAnnIndex": { "type": "boolean", "description": "Rebuilds the ANN index to optimize for recall on the imported data. Only applicable for RagCorpora running on RagManagedDb with `retrieval_strategy` set to `ANN`. The rebuild will be performed using the existing ANN config set on the RagCorpus. To change the ANN config, please use the UpdateRagCorpus API. Default is false, i.e., index is not rebuilt." }, "importResultBigquerySink": { "description": "The BigQuery destination to write import result to. It should be a bigquery table resource name (e.g. \"bq://projectId.bqDatasetId.bqTableId\"). The dataset must exist. If the table does not exist, it will be created with the expected schema. If the table exists, the schema will be validated and data will be added to this existing table.", "$ref": "GoogleCloudAiplatformV1beta1BigQueryDestination" }, "ragFileChunkingConfig": { "deprecated": true, "description": "Specifies the size and overlap of chunks after importing RagFiles.", "$ref": "GoogleCloudAiplatformV1beta1RagFileChunkingConfig" }, "maxEmbeddingRequestsPerMin": { "type": "integer", "format": "int32", "description": "Optional. The max number of queries per minute that this job is allowed to make to the embedding model specified on the corpus. This value is specific to this job and not shared across other import jobs. Consult the Quotas page on the project to set an appropriate value here. If unspecified, a default value of 1,000 QPM would be used." }, "partialFailureGcsSink": { "description": "The Cloud Storage path to write partial failures to. Deprecated. Prefer to use `import_result_gcs_sink`.", "$ref": "GoogleCloudAiplatformV1beta1GcsDestination", "deprecated": true }, "slackSource": { "$ref": "GoogleCloudAiplatformV1beta1SlackSource", "description": "Slack channels with their corresponding access tokens." }, "ragFileMetadataConfig": { "$ref": "GoogleCloudAiplatformV1beta1RagFileMetadataConfig", "description": "Specifies the metadata config for RagFiles. Including paths for metadata schema and metadata. Deprecated: Not in use.", "deprecated": true }, "importResultGcsSink": { "description": "The Cloud Storage path to write import result to.", "$ref": "GoogleCloudAiplatformV1beta1GcsDestination" }, "googleDriveSource": { "description": "Google Drive location. Supports importing individual files as well as Google Drive folders.", "$ref": "GoogleCloudAiplatformV1beta1GoogleDriveSource" }, "gcsSource": { "description": "Google Cloud Storage location. Supports importing individual files as well as entire Google Cloud Storage directories. Sample formats: - `gs://bucket_name/my_directory/object_name/my_file.txt` - `gs://bucket_name/my_directory`", "$ref": "GoogleCloudAiplatformV1beta1GcsSource" }, "jiraSource": { "description": "Jira queries with their corresponding authentication.", "$ref": "GoogleCloudAiplatformV1beta1JiraSource" }, "ragFileTransformationConfig": { "$ref": "GoogleCloudAiplatformV1beta1RagFileTransformationConfig", "description": "Specifies the transformation config for RagFiles." }, "ragFileParsingConfig": { "description": "Optional. Specifies the parsing config for RagFiles. RAG will use the default parser if this field is not set.", "$ref": "GoogleCloudAiplatformV1beta1RagFileParsingConfig" }, "partialFailureBigquerySink": { "description": "The BigQuery destination to write partial failures to. It should be a bigquery table resource name (e.g. \"bq://projectId.bqDatasetId.bqTableId\"). The dataset must exist. If the table does not exist, it will be created with the expected schema. If the table exists, the schema will be validated and data will be added to this existing table. Deprecated. Prefer to use `import_result_bq_sink`.", "deprecated": true, "$ref": "GoogleCloudAiplatformV1beta1BigQueryDestination" }, "globalMaxEmbeddingRequestsPerMin": { "format": "int32", "type": "integer", "description": "Optional. The max number of queries per minute that the indexing pipeline job is allowed to make to the embedding model specified in the project. Please follow the quota usage guideline of the embedding model you use to set the value properly.If this value is not specified, max_embedding_requests_per_min will be used by indexing pipeline job as the global limit." }, "sharePointSources": { "description": "SharePoint sources.", "$ref": "GoogleCloudAiplatformV1beta1SharePointSources" } }, "description": "Config for importing RagFiles.", "type": "object" }, "GoogleCloudAiplatformV1beta1CreateRegistryFeatureOperationMetadata": { "description": "Details of operations that perform create FeatureGroup.", "properties": { "genericMetadata": { "description": "Operation metadata for Feature.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "id": "GoogleCloudAiplatformV1beta1CreateRegistryFeatureOperationMetadata", "type": "object" }, "GoogleCloudAiplatformV1beta1SuggestTrialsMetadata": { "description": "Details of operations that perform Trials suggestion.", "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "Operation metadata for suggesting Trials." }, "clientId": { "description": "The identifier of the client that is requesting the suggestion. If multiple SuggestTrialsRequests have the same `client_id`, the service will return the identical suggested Trial if the Trial is pending, and provide a new Trial if the last suggested Trial was completed.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1SuggestTrialsMetadata", "type": "object" }, "GoogleCloudAiplatformV1beta1PointwiseMetricSpec": { "id": "GoogleCloudAiplatformV1beta1PointwiseMetricSpec", "type": "object", "description": "Spec for pointwise metric.", "properties": { "systemInstruction": { "description": "Optional. System instructions for pointwise metric.", "type": "string" }, "metricPromptTemplate": { "description": "Required. Metric prompt template for pointwise metric.", "type": "string" }, "customOutputFormatConfig": { "$ref": "GoogleCloudAiplatformV1beta1CustomOutputFormatConfig", "description": "Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty." } } }, "GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary": { "description": "The view summary.", "type": "object", "properties": { "severities": { "type": "object", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary" }, "description": "The list of severity summaries for the analyzed sessions. The key is the string representation of Severity enum: \"SEVERITY_UNSPECIFIED\", \"SEVERITY_CRITICAL\", \"SEVERITY_HIGH\", \"SEVERITY_MEDIUM\", \"SEVERITY_LOW\"." }, "anomalousSessionsCount": { "format": "int32", "description": "Number of anomalous sessions.", "type": "integer" }, "anomalousAgentsCount": { "description": "Output only. The number of distinct agents in the request scope with at least one anomalous session in the time window. On `AggregateAnalyzedSessionsResponse.summary` this is a global count; it is not populated on `ListAnalyzedSessionsResponse.summary`.", "readOnly": true, "type": "integer", "format": "int32" }, "llmScannedSessionsCount": { "type": "integer", "description": "Output only. The number of distinct sessions in the time window that were scanned by the LLM judge.", "readOnly": true, "format": "int32" }, "totalSessionsCount": { "format": "int32", "description": "Total number of sessions.", "type": "integer" } }, "id": "GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary" }, "GoogleCloudAiplatformV1beta1ExactMatchInput": { "properties": { "metricSpec": { "description": "Required. Spec for exact match metric.", "$ref": "GoogleCloudAiplatformV1beta1ExactMatchSpec" }, "instances": { "description": "Required. Repeated exact match instances.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1ExactMatchInstance" } } }, "id": "GoogleCloudAiplatformV1beta1ExactMatchInput", "type": "object", "description": "Input for exact match metric." }, "GoogleCloudAiplatformV1beta1SchemaPromptSpecAppBuilderDataLinkedResource": { "type": "object", "description": "A linked resource attached to the application by the user.", "id": "GoogleCloudAiplatformV1beta1SchemaPromptSpecAppBuilderDataLinkedResource", "properties": { "displayName": { "description": "A user-friendly name for the data source shown in the UI.", "type": "string" }, "type": { "description": "The type of the linked resource. e.g., \"SAVED_PROMPT\", \"AI_AGENT\" This string corresponds to the name of the LinkedResourceType enum member. See: google3/cloud/console/web/ai/platform/llm/prompts/build/services/specs_repository_service/linked_resources/linked_resource.ts", "type": "string" }, "name": { "type": "string", "description": "The unique resource name of the data source. The format is determined by the 'type' field. For type \"SAVED_PROMPT\": projects/{project}/locations/{location}/datasets/{dataset} For type \"AI_AGENT\": projects/{project}/locations/{location}/agents/{agent}" } } }, "GenaiVertexV1beta1GoogleSearchResultContentGoogleSearchResult": { "properties": { "searchSuggestions": { "description": "Web content snippet that can be embedded in a web page or an app webview.", "type": "string" } }, "id": "GenaiVertexV1beta1GoogleSearchResultContentGoogleSearchResult", "type": "object", "description": "The result of the Google Search." }, "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig": { "properties": { "thinkingBudget": { "description": "Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.", "format": "int32", "type": "integer" }, "includeThoughts": { "description": "Optional. If true, the model will include its thoughts in the response. \"Thoughts\" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.", "type": "boolean" }, "thinkingLevel": { "type": "string", "enum": [ "THINKING_LEVEL_UNSPECIFIED", "LOW", "MEDIUM", "HIGH", "MINIMAL" ], "enumDescriptions": [ "Unspecified thinking level.", "Low thinking level.", "Medium thinking level.", "High thinking level.", "MINIMAL thinking level." ], "description": "Optional. The number of thoughts tokens that the model should generate." } }, "id": "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig", "description": "Configuration for the model's thinking features. \"Thinking\" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response.", "type": "object" }, "GoogleCloudAiplatformV1beta1ReportRuntimeEventRequest": { "type": "object", "properties": { "vmToken": { "type": "string", "description": "Required. The VM identity token (a JWT) for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity" }, "eventType": { "enumDescriptions": [ "Unspecified.", "Used for readiness reporting.", "Used for idle reporting." ], "enum": [ "EVENT_TYPE_UNSPECIFIED", "HEARTBEAT", "IDLE" ], "type": "string", "description": "Required. The type of the event." }, "eventDetails": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Optional. The details of the request for debug." }, "internalOsServiceStateInstance": { "items": { "$ref": "GoogleCloudAiplatformV1beta1InternalOsServiceStateInstance" }, "description": "The details of the internal os service states.", "deprecated": true, "type": "array" }, "internalOsServiceStateInstances": { "items": { "$ref": "GoogleCloudAiplatformV1beta1InternalOsServiceStateInstance" }, "description": "Optional. The details of the internal os service states.", "type": "array" } }, "id": "GoogleCloudAiplatformV1beta1ReportRuntimeEventRequest", "description": "Request message for NotebookInternalService.ReportRuntimeEvent." }, "GoogleCloudAiplatformV1beta1RagManagedDbConfig": { "type": "object", "description": "Configuration message for RagManagedDb used by RagEngine.", "id": "GoogleCloudAiplatformV1beta1RagManagedDbConfig", "properties": { "enterprise": { "deprecated": true, "description": "Sets the RagManagedDb to the Enterprise tier.", "$ref": "GoogleCloudAiplatformV1beta1RagManagedDbConfigEnterprise" }, "basic": { "deprecated": true, "description": "Deprecated: Use `mode` instead to set the tier under Spanner. Sets the RagManagedDb to the Basic tier.", "$ref": "GoogleCloudAiplatformV1beta1RagManagedDbConfigBasic" }, "spanner": { "description": "Sets the RAG Engine backend to be RagManagedDb, built on top of Spanner. NOTE: This is the default mode (w/ Basic Tier) if not explicitly chosen.", "$ref": "GoogleCloudAiplatformV1beta1RagManagedDbConfigSpanner" }, "unprovisioned": { "$ref": "GoogleCloudAiplatformV1beta1RagManagedDbConfigUnprovisioned", "deprecated": true, "description": "Deprecated: Use `mode` instead to set the tier under Spanner. Sets the RagManagedDb to the Unprovisioned tier." }, "serverless": { "$ref": "GoogleCloudAiplatformV1beta1RagManagedDbConfigServerless", "description": "Sets the backend to be the serverless mode offered by RAG Engine." }, "scaled": { "$ref": "GoogleCloudAiplatformV1beta1RagManagedDbConfigScaled", "deprecated": true, "description": "Deprecated: Use `mode` instead to set the tier under Spanner. Sets the RagManagedDb to the Scaled tier." } } }, "GoogleCloudAiplatformV1beta1StudySpecMetricSpecSafetyMetricConfig": { "id": "GoogleCloudAiplatformV1beta1StudySpecMetricSpecSafetyMetricConfig", "description": "Used in safe optimization to specify threshold levels and risk tolerance.", "type": "object", "properties": { "safetyThreshold": { "format": "double", "description": "Safety threshold (boundary value between safe and unsafe). NOTE that if you leave SafetyMetricConfig unset, a default value of 0 will be used.", "type": "number" }, "desiredMinSafeTrialsFraction": { "type": "number", "description": "Desired minimum fraction of safe trials (over total number of trials) that should be targeted by the algorithm at any time during the study (best effort). This should be between 0.0 and 1.0 and a value of 0.0 means that there is no minimum and an algorithm proceeds without targeting any specific fraction. A value of 1.0 means that the algorithm attempts to only Suggest safe Trials.", "format": "double" } } }, "GoogleCloudAiplatformV1beta1ReinforcementTuningRewardInfo": { "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningRewardInfo", "type": "object", "properties": { "reward": { "type": "number", "format": "float", "description": "Output only. The calculated reward for the reward function.", "readOnly": true }, "userRequestedAuxInfo": { "description": "Output only. The user-requested auxiliary info for the reward function. This field is set only if the Cloud Run reward function configured by user returns a \"user_requested_aux_info\". Refer to ReinforcementTuningCloudRunRewardScorer for more details.", "readOnly": true, "type": "string" }, "errorStatus": { "readOnly": true, "description": "Output only. In case of an error for this reward, this field will be populated with a detailed error status.", "$ref": "GoogleRpcStatus" } }, "description": "The reward info for a reward function." }, "CloudAiPlatformCommonCreatePipelineJobApiErrorDetail": { "description": "Create API error message for Vertex Pipeline.", "type": "object", "properties": { "errorCause": { "description": "The error root cause returned by CreatePipelineJob API.", "enum": [ "ERROR_CAUSE_UNSPECIFIED", "INVALID_PIPELINE_SPEC_FORMAT", "INVALID_PIPELINE_SPEC", "INVALID_DEPLOYMENT_CONFIG", "INVALID_DEPLOYMENT_SPEC", "INVALID_INSTANCE_SCHEMA", "INVALID_CUSTOM_JOB", "INVALID_CONTAINER_SPEC", "INVALID_NOTIFICATION_EMAIL_SETUP", "INVALID_SERVICE_ACCOUNT_SETUP", "INVALID_KMS_SETUP", "INVALID_NETWORK_SETUP", "INVALID_PIPELINE_TASK_SPEC", "INVALID_PIPELINE_TASK_ARTIFACT", "INVALID_IMPORTER_SPEC", "INVALID_RESOLVER_SPEC", "INVALID_RUNTIME_PARAMETERS", "CLOUD_API_NOT_ENABLED", "INVALID_GCS_INPUT_URI", "INVALID_GCS_OUTPUT_URI", "INVALID_COMPONENT_SPEC", "INVALID_DAG_OUTPUTS_SPEC", "INVALID_DAG_SPEC", "INSUFFICIENT_QUOTA", "INTERNAL" ], "type": "string", "enumDescriptions": [ "Should never be used.", "IR Pipeline Spec can not been parsed to yaml or json format.", "A pipeline spec is invalid.", "A deployment config is invalid.", "A deployment spec is invalid.", "An instance schema is invalid.", "A custom job is invalid.", "A container spec is invalid.", "Notification email setup is invalid.", "Service account setup is invalid.", "KMS setup is invalid.", "Network setup is invalid.", "Task spec is invalid.", "Task artifact is invalid.", "Importer spec is invalid.", "Resolver spec is invalid.", "Runtime Parameters are invalid.", "Cloud API not enabled.", "Invalid Cloud Storage input uri", "Invalid Cloud Storage output uri", "Component spec of pipeline is invalid.", "DagOutputsSpec is invalid.", "DagSpec is invalid.", "Project does not have enough quota.", "An internal error with unknown cause." ] }, "publicMessage": { "description": "Public messages contains actionable items for the error cause.", "type": "string" } }, "id": "CloudAiPlatformCommonCreatePipelineJobApiErrorDetail" }, "GoogleCloudAiplatformV1beta1AudioTranscriptionWordInfo": { "type": "object", "id": "GoogleCloudAiplatformV1beta1AudioTranscriptionWordInfo", "properties": { "startOffset": { "format": "google-duration", "type": "string", "description": "Optional. Start offset in time of the word relative to the start of the audio." }, "endOffset": { "format": "google-duration", "description": "Optional. End offset in time of the word relative to the start of the audio.", "type": "string" }, "word": { "type": "string", "description": "Required. Transcript of the word." } }, "description": "Information about a single recognized word." }, "GoogleCloudAiplatformV1beta1ListIndexEndpointsResponse": { "properties": { "nextPageToken": { "description": "A token to retrieve next page of results. Pass to ListIndexEndpointsRequest.page_token to obtain that page.", "type": "string" }, "indexEndpoints": { "description": "List of IndexEndpoints in the requested page.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint" } } }, "id": "GoogleCloudAiplatformV1beta1ListIndexEndpointsResponse", "type": "object", "description": "Response message for IndexEndpointService.ListIndexEndpoints." }, "GoogleCloudAiplatformV1beta1ListStudiesResponse": { "id": "GoogleCloudAiplatformV1beta1ListStudiesResponse", "properties": { "nextPageToken": { "description": "Passes this token as the `page_token` field of the request for a subsequent call. If this field is omitted, there are no subsequent pages.", "type": "string" }, "studies": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Study" }, "description": "The studies associated with the project." } }, "description": "Response message for VizierService.ListStudies.", "type": "object" }, "GoogleCloudAiplatformV1beta1NasTrial": { "id": "GoogleCloudAiplatformV1beta1NasTrial", "type": "object", "properties": { "finalMeasurement": { "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1Measurement", "description": "Output only. The final measurement containing the objective value." }, "state": { "type": "string", "readOnly": true, "description": "Output only. The detailed state of the NasTrial.", "enum": [ "STATE_UNSPECIFIED", "REQUESTED", "ACTIVE", "STOPPING", "SUCCEEDED", "INFEASIBLE" ], "enumDescriptions": [ "The NasTrial state is unspecified.", "Indicates that a specific NasTrial has been requested, but it has not yet been suggested by the service.", "Indicates that the NasTrial has been suggested.", "Indicates that the NasTrial should stop according to the service.", "Indicates that the NasTrial is completed successfully.", "Indicates that the NasTrial should not be attempted again. The service will set a NasTrial to INFEASIBLE when it's done but missing the final_measurement." ] }, "startTime": { "type": "string", "description": "Output only. Time when the NasTrial was started.", "format": "google-datetime", "readOnly": true }, "id": { "description": "Output only. The identifier of the NasTrial assigned by the service.", "type": "string", "readOnly": true }, "endTime": { "format": "google-datetime", "type": "string", "description": "Output only. Time when the NasTrial's status changed to `SUCCEEDED` or `INFEASIBLE`.", "readOnly": true } }, "description": "Represents a uCAIP NasJob trial." }, "GoogleCloudAiplatformV1beta1DeleteFeatureValuesResponseSelectTimeRangeAndFeature": { "id": "GoogleCloudAiplatformV1beta1DeleteFeatureValuesResponseSelectTimeRangeAndFeature", "properties": { "offlineStorageModifiedEntityRowCount": { "description": "The count of modified entity rows in the offline storage. Each row corresponds to the combination of an entity ID and a timestamp. One entity ID can have multiple rows in the offline storage. Within each row, only the features specified in the request are deleted.", "type": "string", "format": "int64" }, "onlineStorageModifiedEntityCount": { "format": "int64", "description": "The count of modified entities in the online storage. Each entity ID corresponds to one entity. Within each entity, only the features specified in the request are deleted.", "type": "string" }, "impactedFeatureCount": { "type": "string", "format": "int64", "description": "The count of the features or columns impacted. This is the same as the feature count in the request." } }, "description": "Response message if the request uses the SelectTimeRangeAndFeature option.", "type": "object" }, "CloudAiLargeModelsVisionPromptInputs": { "properties": { "audioPrompt": { "description": "Description of audio content in the video, without speech.", "type": "string" }, "negativeAudioPrompt": { "description": "Negative description of audio content in the video.", "type": "string" }, "promptChunks": { "description": "2s, 256 tokens per chunk, 4 total chunks. Required.", "items": { "type": "string" }, "type": "array" }, "transcript": { "description": "Spoken transcript of the video for characters.", "type": "string" }, "negativePrompt": { "description": "Single negative prompt for what not to generate.", "type": "string" } }, "id": "CloudAiLargeModelsVisionPromptInputs", "type": "object", "description": "\"Direct\" prompting for Experimental Video Generation. These will be sent directly to the LDM without being rewritten." }, "GoogleCloudAiplatformV1beta1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec": { "id": "GoogleCloudAiplatformV1beta1NasJobSpecMultiTrialAlgorithmSpecSearchTrialSpec", "type": "object", "description": "Represent spec for search trials.", "properties": { "maxFailedTrialCount": { "description": "The number of failed trials that need to be seen before failing the NasJob. If set to 0, Vertex AI decides how many trials must fail before the whole job fails.", "format": "int32", "type": "integer" }, "maxTrialCount": { "description": "Required. The maximum number of Neural Architecture Search (NAS) trials to run.", "format": "int32", "type": "integer" }, "maxParallelTrialCount": { "type": "integer", "description": "Required. The maximum number of trials to run in parallel.", "format": "int32" }, "searchTrialJobSpec": { "$ref": "GoogleCloudAiplatformV1beta1CustomJobSpec", "description": "Required. The spec of a search trial job. The same spec applies to all search trials." } } }, "GoogleCloudAiplatformV1beta1TaskDescriptionStrategy": { "type": "object", "properties": { "taskDescription": { "type": "string", "description": "Required. A general description of the type of synthetic data you want to generate. For example, \"Generate customer reviews for a new smartphone.\"" } }, "id": "GoogleCloudAiplatformV1beta1TaskDescriptionStrategy", "description": "Defines a generation strategy based on a general task description." }, "GenaiVertexV1beta1CodeExecutionCallContentCodeExecutionCallArguments": { "properties": { "language": { "description": "Programming language of the `code`.", "type": "string", "enum": [ "LANGUAGE_UNSPECIFIED", "PYTHON" ], "enumDescriptions": [ "Unspecified language. This value should not be used.", "Python \u003e= 3.10, with numpy and simpy available." ] }, "code": { "type": "string", "description": "The code to be executed." } }, "id": "GenaiVertexV1beta1CodeExecutionCallContentCodeExecutionCallArguments", "description": "The arguments to pass to the code execution.", "type": "object" }, "GoogleCloudAiplatformV1beta1IdMatcher": { "id": "GoogleCloudAiplatformV1beta1IdMatcher", "type": "object", "description": "Matcher for Features of an EntityType by Feature ID.", "properties": { "ids": { "items": { "type": "string" }, "type": "array", "description": "Required. The following are accepted as `ids`: * A single-element list containing only `*`, which selects all Features in the target EntityType, or * A list containing only Feature IDs, which selects only Features with those IDs in the target EntityType." } } }, "GoogleCloudAiplatformV1beta1ColabImage": { "properties": { "releaseName": { "description": "Optional. The release name of the NotebookRuntime Colab image, e.g. \"py310\". If not specified, detault to the latest release.", "type": "string" }, "description": { "readOnly": true, "type": "string", "description": "Output only. A human-readable description of the specified colab image release, populated by the system. Example: \"Python 3.10\", \"Latest - current Python 3.11\"" } }, "type": "object", "description": "Colab image of the runtime.", "id": "GoogleCloudAiplatformV1beta1ColabImage" }, "GoogleCloudAiplatformV1beta1BatchPredictionJobOutputInfo": { "id": "GoogleCloudAiplatformV1beta1BatchPredictionJobOutputInfo", "type": "object", "properties": { "vertexMultimodalDatasetName": { "type": "string", "readOnly": true, "description": "Output only. The resource name of the Vertex Managed Dataset created, into which the prediction output is written. Format: `projects/{project}/locations/{location}/datasets/{dataset}`" }, "gcsOutputDirectory": { "description": "Output only. The full path of the Cloud Storage directory created, into which the prediction output is written.", "readOnly": true, "type": "string" }, "bigqueryOutputTable": { "description": "Output only. The name of the BigQuery table created, in `predictions_` format, into which the prediction output is written. Can be used by UI to generate the BigQuery output path, for example.", "type": "string", "readOnly": true }, "bigqueryOutputDataset": { "type": "string", "description": "Output only. The path of the BigQuery dataset created, in `bq://projectId.bqDatasetId` format, into which the prediction output is written.", "readOnly": true } }, "description": "Further describes this job's output. Supplements output_config." }, "GoogleCloudAiplatformV1beta1ListTrainingPipelinesResponse": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ListTrainingPipelinesResponse", "description": "Response message for PipelineService.ListTrainingPipelines", "properties": { "trainingPipelines": { "description": "List of TrainingPipelines in the requested page.", "items": { "$ref": "GoogleCloudAiplatformV1beta1TrainingPipeline" }, "type": "array" }, "nextPageToken": { "description": "A token to retrieve the next page of results. Pass to ListTrainingPipelinesRequest.page_token to obtain that page.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1ModelMonitoringNotificationSpec": { "properties": { "emailConfig": { "description": "Email alert config.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringNotificationSpecEmailConfig" }, "enableCloudLogging": { "description": "Dump the anomalies to Cloud Logging. The anomalies will be put to json payload encoded from proto google.cloud.aiplatform.logging.ModelMonitoringAnomaliesLogEntry. This can be further sinked to Pub/Sub or any other services supported by Cloud Logging.", "type": "boolean" }, "notificationChannelConfigs": { "items": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringNotificationSpecNotificationChannelConfig" }, "description": "Notification channel config.", "type": "array" } }, "id": "GoogleCloudAiplatformV1beta1ModelMonitoringNotificationSpec", "description": "Notification spec(email, notification channel) for model monitoring statistics/alerts.", "type": "object" }, "GoogleCloudAiplatformV1beta1MergeVersionAliasesRequest": { "type": "object", "description": "Request message for ModelService.MergeVersionAliases.", "properties": { "versionAliases": { "items": { "type": "string" }, "description": "Required. The set of version aliases to merge. The alias should be at most 128 characters, and match `a-z{0,126}[a-z-0-9]`. Add the `-` prefix to an alias means removing that alias from the version. `-` is NOT counted in the 128 characters. Example: `-golden` means removing the `golden` alias from the version. There is NO ordering in aliases, which means 1) The aliases returned from GetModel API might not have the exactly same order from this MergeVersionAliases API. 2) Adding and deleting the same alias in the request is not recommended, and the 2 operations will be cancelled out.", "type": "array" } }, "id": "GoogleCloudAiplatformV1beta1MergeVersionAliasesRequest" }, "GenaiVertexV1beta1UrlContextResultStep": { "id": "GenaiVertexV1beta1UrlContextResultStep", "type": "object", "description": "URL context result step.", "properties": { "result": { "type": "array", "description": "Required. The results of the URL context.", "items": { "$ref": "GenaiVertexV1beta1UrlContextResultStepUrlContextResultItem" } }, "isError": { "type": "boolean", "description": "Whether the URL context resulted in an error." } } }, "GoogleCloudAiplatformV1beta1ListAnalyzedInvocationsResponse": { "type": "object", "properties": { "analyzedInvocations": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1AnalyzedInvocation" }, "description": "The list of analyzed invocations." }, "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results." } }, "id": "GoogleCloudAiplatformV1beta1ListAnalyzedInvocationsResponse", "description": "Response to list analyzed invocations." }, "GoogleCloudAiplatformV1beta1ListTrialsResponse": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ListTrialsResponse", "description": "Response message for VizierService.ListTrials.", "properties": { "trials": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Trial" }, "description": "The Trials associated with the Study.", "type": "array" }, "nextPageToken": { "description": "Pass this token as the `page_token` field of the request for a subsequent call. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs": { "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoActionRecognitionInputs", "properties": { "modelType": { "enum": [ "MODEL_TYPE_UNSPECIFIED", "CLOUD", "MOBILE_VERSATILE_1", "MOBILE_JETSON_VERSATILE_1", "MOBILE_CORAL_VERSATILE_1" ], "type": "string", "enumDescriptions": [ "Should not be set.", "A model best tailored to be used within Google Cloud, and which c annot be exported. Default.", "A model that, in addition to being available within Google Cloud, can also be exported (see ModelService.ExportModel) as a TensorFlow or TensorFlow Lite model and used on a mobile or edge device afterwards.", "A model that, in addition to being available within Google Cloud, can also be exported (see ModelService.ExportModel) to a Jetson device afterwards.", "A model that, in addition to being available within Google Cloud, can also be exported (see ModelService.ExportModel) as a TensorFlow or TensorFlow Lite model and used on a Coral device afterwards." ] } }, "type": "object" }, "GoogleCloudAiplatformV1beta1DirectPredictRequest": { "description": "Request message for PredictionService.DirectPredict.", "properties": { "parameters": { "description": "The parameters that govern the prediction.", "$ref": "GoogleCloudAiplatformV1beta1Tensor" }, "inputs": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Tensor" }, "type": "array", "description": "The prediction input." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1DirectPredictRequest" }, "GoogleCloudAiplatformV1beta1SchemaAnnotationSpecColor": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaAnnotationSpecColor", "description": "An entry of mapping between color and AnnotationSpec. The mapping is used in segmentation mask.", "properties": { "displayName": { "description": "The display name of the AnnotationSpec represented by the color in the segmentation mask.", "type": "string" }, "color": { "$ref": "GoogleTypeColor", "description": "The color of the AnnotationSpec in a segmentation mask." }, "id": { "description": "The ID of the AnnotationSpec represented by the color in the segmentation mask.", "type": "string" } } }, "GenaiVertexV1beta1GoogleMapsCallStep": { "description": "Google Maps call step.", "properties": { "arguments": { "$ref": "GenaiVertexV1beta1GoogleMapsCallStepGoogleMapsCallStepArguments", "description": "The arguments to pass to the Google Maps tool." } }, "id": "GenaiVertexV1beta1GoogleMapsCallStep", "type": "object" }, "GoogleCloudAiplatformV1beta1SessionEvent": { "id": "GoogleCloudAiplatformV1beta1SessionEvent", "properties": { "invocationId": { "description": "Required. The invocation id of the event, multiple events can have the same invocation id.", "type": "string" }, "rawEvent": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. Weakly typed raw event data in proto struct format.", "type": "object" }, "author": { "description": "Required. The name of the agent that sent the event, or user.", "type": "string" }, "eventMetadata": { "description": "Optional. Metadata relating to this event.", "$ref": "GoogleCloudAiplatformV1beta1EventMetadata" }, "errorMessage": { "type": "string", "description": "Optional. Error message if the response is an error." }, "name": { "description": "Identifier. The resource name of the event. Format:`projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event}`.", "type": "string" }, "timestamp": { "format": "google-datetime", "type": "string", "description": "Required. Timestamp when the event was created on client side." }, "content": { "description": "Optional. Content of the event provided by the author.", "$ref": "GoogleCloudAiplatformV1beta1Content" }, "errorCode": { "type": "string", "description": "Optional. Error code if the response is an error. Code varies by model." }, "actions": { "description": "Optional. Actions executed by the agent.", "$ref": "GoogleCloudAiplatformV1beta1EventActions" } }, "description": "An event represents a message from either the user or agent.", "type": "object" }, "GoogleCloudAiplatformV1beta1UpdateFeatureOnlineStoreOperationMetadata": { "id": "GoogleCloudAiplatformV1beta1UpdateFeatureOnlineStoreOperationMetadata", "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "Operation metadata for FeatureOnlineStore." } }, "type": "object", "description": "Details of operations that perform update FeatureOnlineStore." }, "GoogleCloudAiplatformV1beta1SearchExamplesResponse": { "description": "Response message for ExampleStoreService.SearchExamples.", "id": "GoogleCloudAiplatformV1beta1SearchExamplesResponse", "properties": { "results": { "description": "The results of searching for similar examples.", "items": { "$ref": "GoogleCloudAiplatformV1beta1SearchExamplesResponseSimilarExample" }, "type": "array" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1Trial": { "properties": { "webAccessUris": { "type": "object", "readOnly": true, "additionalProperties": { "type": "string" }, "description": "Output only. URIs for accessing [interactive shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) (one URI for each training node). Only available if this trial is part of a HyperparameterTuningJob and the job's trial_job_spec.enable_web_access field is `true`. The keys are names of each node used for the trial; for example, `workerpool0-0` for the primary node, `workerpool1-0` for the first node in the second worker pool, and `workerpool1-1` for the second node in the second worker pool. The values are the URIs for each node's interactive shell." }, "parameters": { "items": { "$ref": "GoogleCloudAiplatformV1beta1TrialParameter" }, "type": "array", "readOnly": true, "description": "Output only. The parameters of the Trial." }, "endTime": { "description": "Output only. Time when the Trial's status changed to `SUCCEEDED` or `INFEASIBLE`.", "format": "google-datetime", "type": "string", "readOnly": true }, "infeasibleReason": { "readOnly": true, "type": "string", "description": "Output only. A human readable string describing why the Trial is infeasible. This is set only if Trial state is `INFEASIBLE`." }, "clientId": { "type": "string", "description": "Output only. The identifier of the client that originally requested this Trial. Each client is identified by a unique client_id. When a client asks for a suggestion, Vertex AI Vizier will assign it a Trial. The client should evaluate the Trial, complete it, and report back to Vertex AI Vizier. If suggestion is asked again by same client_id before the Trial is completed, the same Trial will be returned. Multiple clients with different client_ids can ask for suggestions simultaneously, each of them will get their own Trial.", "readOnly": true }, "name": { "description": "Output only. Resource name of the Trial assigned by the service.", "readOnly": true, "type": "string" }, "id": { "description": "Output only. The identifier of the Trial assigned by the service.", "type": "string", "readOnly": true }, "measurements": { "readOnly": true, "type": "array", "description": "Output only. A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_duration). These are used for early stopping computations.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Measurement" } }, "finalMeasurement": { "readOnly": true, "description": "Output only. The final measurement containing the objective value.", "$ref": "GoogleCloudAiplatformV1beta1Measurement" }, "startTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. Time when the Trial was started." }, "customJob": { "type": "string", "description": "Output only. The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial.", "readOnly": true }, "state": { "enumDescriptions": [ "The Trial state is unspecified.", "Indicates that a specific Trial has been requested, but it has not yet been suggested by the service.", "Indicates that the Trial has been suggested.", "Indicates that the Trial should stop according to the service.", "Indicates that the Trial is completed successfully.", "Indicates that the Trial should not be attempted again. The service will set a Trial to INFEASIBLE when it's done but missing the final_measurement." ], "type": "string", "description": "Output only. The detailed state of the Trial.", "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "REQUESTED", "ACTIVE", "STOPPING", "SUCCEEDED", "INFEASIBLE" ] } }, "id": "GoogleCloudAiplatformV1beta1Trial", "type": "object", "description": "A message representing a Trial. A Trial contains a unique set of Parameters that has been or will be evaluated, along with the objective metrics got by running the Trial." }, "GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerStringMatchExpression": { "description": "Evaluates parsed response using match type against the expression. Returns `true` if `MatchOperation(target, expression)` evaluates to `true`, and `false` otherwise.", "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerStringMatchExpression", "type": "object", "properties": { "matchOperation": { "enum": [ "MATCH_OPERATION_UNSPECIFIED", "REGEX_CONTAINS", "PARTIAL_MATCH", "EXACT_MATCH" ], "type": "string", "description": "Match operation to use for evaluating rewards.", "enumDescriptions": [ "Default value. A user error will be returned if not set.", "Equivalent to [GoogleSQL](https://cloud.google.com/bigquery/docs/reference/standard-sql/string_functions#regexp_contains) `REGEX_CONTAINS(target, expression)`.", "The match operation returns `true` if expression is a substring of the target.", "The match operation returns `true` expression is an exact match of the target." ] }, "expression": { "description": "A string or a regular expression to match against for evaluating rewards. Users can also provide a references map of `{key: value}` whose `value` will be used to replace the placeholder {{references.key}} in the expression. For example, if the following `references` are defined in the training / validation dataset: ``` { \"systemInstruction\": ..., \"contents\": ..., \"references\": { \"concise_answer\": \"Yes\", \"verbose_answer\": \"The answer is Yes\" } } ``` and if users define the following StringMatchExpression: { \"matchOperation\": \"REGEX_CONTAINS\", \"expression\": \".*{{references.concise_answer}}.*\" } On evaluating the reward for each sample response, this StringMatchExpression will be substituted as: ``` { \"matchOperation\": \"REGEX_CONTAINS\", \"expression\": \".*Yes.*\" } ```", "type": "string" } } }, "GoogleCloudAiplatformV1beta1RagContexts": { "properties": { "contexts": { "description": "All its contexts.", "items": { "$ref": "GoogleCloudAiplatformV1beta1RagContextsContext" }, "type": "array" } }, "description": "Relevant contexts for one query.", "id": "GoogleCloudAiplatformV1beta1RagContexts", "type": "object" }, "GoogleCloudAiplatformV1beta1AddContextArtifactsAndExecutionsRequest": { "properties": { "artifacts": { "description": "The resource names of the Artifacts to attribute to the Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`", "type": "array", "items": { "type": "string" } }, "executions": { "description": "The resource names of the Executions to associate with the Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`", "type": "array", "items": { "type": "string" } } }, "description": "Request message for MetadataService.AddContextArtifactsAndExecutions.", "id": "GoogleCloudAiplatformV1beta1AddContextArtifactsAndExecutionsRequest", "type": "object" }, "CloudAiLargeModelsVisionGenerateVideoExperimentsOutpaintConfigFrameSource": { "type": "object", "id": "CloudAiLargeModelsVisionGenerateVideoExperimentsOutpaintConfigFrameSource", "properties": { "verticalOffset": { "description": "Vertical offset in pixels to shift the input frame from center. Positive values shift down, negative values shift up. Optional. Default is 0 (centered).", "type": "integer", "format": "int32" }, "globPattern": { "type": "string" }, "horizontalOffset": { "description": "Horizontal offset in pixels to shift the input frame from center. Positive values shift right, negative values shift left. Optional. Default is 0 (centered).", "type": "integer", "format": "int32" } }, "description": "The input frame(s). It can be a full path or a glob pattern to images. The proto can be extended in the future for alternative ways to specify source of frames." }, "GenaiVertexV1beta1FileSearchResultStep": { "properties": {}, "description": "File Search result step.", "type": "object", "id": "GenaiVertexV1beta1FileSearchResultStep" }, "GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexVectorSearch": { "description": "The config for the Vertex Vector Search.", "type": "object", "id": "GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexVectorSearch", "properties": { "indexEndpoint": { "description": "The resource name of the Index Endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", "type": "string" }, "index": { "type": "string", "description": "The resource name of the Index. Format: `projects/{project}/locations/{location}/indexes/{index}`" } } }, "GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResult": { "type": "object", "id": "GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResult", "description": "The result of the Google Maps.", "properties": { "widgetContextToken": { "description": "Resource name of the Google Maps widget context token.", "type": "string" }, "places": { "type": "array", "items": { "$ref": "GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResultPlaces" }, "description": "The places that were found." } } }, "GoogleCloudAiplatformV1beta1ReadTensorboardUsageResponsePerMonthUsageData": { "properties": { "userUsageData": { "type": "array", "description": "Usage data for each user in the given month.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardUsageResponsePerUserUsageData" } } }, "id": "GoogleCloudAiplatformV1beta1ReadTensorboardUsageResponsePerMonthUsageData", "description": "Per month usage data", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation": { "type": "object", "description": "Training pipeline will perform following transformation functions. * The text as is--no change to case, punctuation, spelling, tense, and so on. * Convert the category name to a dictionary lookup index and generate an embedding for each index.", "properties": { "columnName": { "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTextTransformation" }, "GoogleCloudAiplatformV1beta1VertexRagStoreRagResource": { "description": "The definition of the Rag resource.", "id": "GoogleCloudAiplatformV1beta1VertexRagStoreRagResource", "type": "object", "properties": { "ragCorpus": { "description": "Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", "type": "string" }, "ragFileIds": { "description": "Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.", "items": { "type": "string" }, "type": "array" } } }, "GoogleCloudAiplatformV1beta1EventActions": { "properties": { "skipSummarization": { "type": "boolean", "description": "Optional. If true, it won't call model to summarize function response. Only used for function_response event." }, "stateDelta": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. Indicates that the event is updating the state with the given delta." }, "transferAgent": { "description": "Optional. If set, the event transfers to the specified agent.", "type": "string" }, "requestedAuthConfigs": { "type": "object", "description": "Optional. Will only be set by a tool response indicating tool request euc. Struct key is the function call id since one function call response (from model) could correspond to multiple function calls. Struct value is the required auth config, which can be another struct.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "artifactDelta": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "description": "Optional. Indicates that the event is updating an artifact. key is the filename, value is the version." }, "escalate": { "description": "Optional. The agent is escalating to a higher level agent.", "type": "boolean" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1EventActions", "description": "Actions are parts of events that are executed by the agent." }, "GoogleCloudAiplatformV1beta1ModelVersionCheckpoint": { "type": "object", "description": "Describes the machine learning model version checkpoint.", "deprecated": true, "properties": { "step": { "format": "int64", "type": "string", "description": "The step of the checkpoint." }, "checkpointId": { "description": "The ID of the checkpoint.", "type": "string" }, "epoch": { "type": "string", "description": "The epoch of the checkpoint.", "format": "int64" } }, "id": "GoogleCloudAiplatformV1beta1ModelVersionCheckpoint" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata": { "type": "object", "properties": { "costMilliNodeHours": { "description": "The actual training cost of creating this model, expressed in milli node hours, i.e. 1,000 value in this field means 1 node hour. Guaranteed to not exceed inputs.budgetMilliNodeHours.", "format": "int64", "type": "string" }, "successfulStopReason": { "enum": [ "SUCCESSFUL_STOP_REASON_UNSPECIFIED", "BUDGET_REACHED", "MODEL_CONVERGED" ], "description": "For successful job completions, this is the reason why the job has finished.", "type": "string", "enumDescriptions": [ "Should not be set.", "The inputs.budgetMilliNodeHours had been reached.", "Further training of the Model ceased to increase its quality, since it already has converged." ] } }, "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlImageClassificationMetadata" }, "GoogleCloudAiplatformV1beta1SchemaPromptSpecMultimodalPrompt": { "properties": { "promptMessage": { "description": "The prompt message.", "$ref": "GoogleCloudAiplatformV1beta1SchemaPromptSpecPromptMessage" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaPromptSpecMultimodalPrompt", "description": "Prompt variation that embeds preambles to prompt string." }, "GoogleCloudAiplatformV1beta1UrlContext": { "properties": {}, "description": "Tool to support URL context.", "type": "object", "id": "GoogleCloudAiplatformV1beta1UrlContext" }, "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployDeployMetadata": { "id": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployDeployMetadata", "description": "Metadata information about the deployment for managing deployment config.", "type": "object", "properties": { "labels": { "description": "Optional. Labels for the deployment config. For managing deployment config like verifying, source of deployment config, etc.", "type": "object", "additionalProperties": { "type": "string" } }, "sampleRequest": { "type": "string", "description": "Optional. Sample request for deployed endpoint." } } }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation": { "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationNumericTransformation", "properties": { "columnName": { "type": "string" } }, "description": "Training pipeline will perform following transformation functions. * The value converted to float32. * The z_score of the value. * log(value+1) when the value is greater than or equal to 0. Otherwise, this transformation is not applied and the value is considered a missing value. * z_score of log(value+1) when the value is greater than or equal to 0. Otherwise, this transformation is not applied and the value is considered a missing value.", "type": "object" }, "GoogleCloudAiplatformV1beta1TensorboardBlob": { "type": "object", "id": "GoogleCloudAiplatformV1beta1TensorboardBlob", "description": "One blob (e.g, image, graph) viewable on a blob metric plot.", "properties": { "id": { "type": "string", "readOnly": true, "description": "Output only. A URI safe key uniquely identifying a blob. Can be used to locate the blob stored in the Cloud Storage bucket of the consumer project." }, "data": { "type": "string", "format": "byte", "description": "Optional. The bytes of the blob is not present unless it's returned by the ReadTensorboardBlobData endpoint." } } }, "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsRequest": { "id": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsRequest", "description": "Request message for EvaluationService.GenerateInstanceRubrics.", "properties": { "location": { "type": "string", "description": "Required. The resource name of the Location to generate rubrics from. Format: `projects/{project}/locations/{location}`" }, "metricResourceName": { "type": "string", "description": "Optional. The resource name of a registered metric. Rubric generation using predefined metric spec or LLMBasedMetricSpec is supported. If this field is set, the configuration provided in this field is used for rubric generation. The `predefined_rubric_generation_spec` and `rubric_generation_spec` fields will be ignored." }, "contents": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" }, "description": "Required. The prompt to generate rubrics from. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request." }, "agentConfig": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentConfig", "description": "Optional. Agent configuration, required for agent-based rubric generation." }, "predefinedRubricGenerationSpec": { "$ref": "GoogleCloudAiplatformV1beta1PredefinedMetricSpec", "description": "Optional. Specification for using the rubric generation configs of a pre-defined metric, e.g. \"generic_quality_v1\" and \"instruction_following_v1\". Some of the configs may be only used in rubric generation and not supporting evaluation, e.g. \"fully_customized_generic_quality_v1\". If this field is set, the `rubric_generation_spec` field will be ignored." }, "rubricGenerationSpec": { "description": "Optional. Specification for how the rubrics should be generated.", "$ref": "GoogleCloudAiplatformV1beta1RubricGenerationSpec" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1EncryptionSpec": { "description": "Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource.", "type": "object", "properties": { "kmsKeyName": { "description": "Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1EncryptionSpec" }, "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequest": { "properties": { "gcsSource": { "description": "Google Cloud Storage location.", "$ref": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestGcsSource" }, "evaluationSet": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationSet", "description": "Required. The EvaluationSet to create. Used to specify 'display_name' and 'metadata'. The 'evaluation_items' field is ignored and populated by the import process." }, "interactionsSource": { "description": "Optional. Source for importing Interactions API interactions.", "$ref": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestInteractionsSource" }, "bigquerySource": { "$ref": "GoogleCloudAiplatformV1beta1BigQueryRequestSet", "description": "BigQuery source with column mappings." }, "gcsDestination": { "description": "Required. The Cloud Storage location where the resulting EvaluationItem payloads will be stored.", "$ref": "GoogleCloudAiplatformV1beta1GcsDestination" }, "inlineSource": { "description": "Inline source for small payloads (\u003c 4MB).", "$ref": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestInlineSource" }, "cloudTraceSource": { "description": "Source for loading data directly from Cloud Trace.", "$ref": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestCloudTraceSource" }, "agentEngineSource": { "$ref": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestAgentEngineSource", "description": "Source for loading Agent Engine sessions." } }, "id": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequest", "description": "Request message for EvaluationManagementService.ImportEvaluationSet.", "type": "object" }, "GoogleCloudAiplatformV1beta1DeployedIndexAuthConfig": { "type": "object", "description": "Used to set up the auth on the DeployedIndex's private endpoint.", "properties": { "authProvider": { "$ref": "GoogleCloudAiplatformV1beta1DeployedIndexAuthConfigAuthProvider", "description": "Defines the authentication provider that the DeployedIndex uses." } }, "id": "GoogleCloudAiplatformV1beta1DeployedIndexAuthConfig" }, "GoogleCloudAiplatformV1beta1ReasoningEngineTrafficConfigTrafficSplitManual": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ReasoningEngineTrafficConfigTrafficSplitManual", "properties": { "targets": { "type": "array", "description": "A list of traffic targets for the Runtimes Revisions. The sum of percentages must equal to 100.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineTrafficConfigTrafficSplitManualTarget" } } }, "description": "Manual traffic distribution configuration, where the user specifies the Runtime Revision IDs and the percentage of traffic to send to each." }, "GoogleCloudAiplatformV1beta1SemanticGovernancePolicyMcpTool": { "properties": { "tools": { "type": "array", "description": "Optional. The resource names of the McpTools used by the Agent that is affected by this policy. If not specified, the policy applies to all McpTools in the McpServer.", "items": { "type": "string" } }, "mcpServer": { "type": "string", "description": "Required. The resource name of the McpServer in Agent Registry that is affected by this policy. Format: `projects/{project}/locations/{location}/mcpServers/{mcp_server}`" } }, "type": "object", "description": "Represents a governance policy applied to MCP tools used by an Agent.", "id": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicyMcpTool" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs": { "properties": { "modelType": { "type": "string", "enum": [ "MODEL_TYPE_UNSPECIFIED", "CLOUD", "MOBILE_VERSATILE_1", "MOBILE_JETSON_VERSATILE_1" ], "enumDescriptions": [ "Should not be set.", "A model best tailored to be used within Google Cloud, and which cannot be exported. Default.", "A model that, in addition to being available within Google Cloud, can also be exported (see ModelService.ExportModel) as a TensorFlow or TensorFlow Lite model and used on a mobile or edge device afterwards.", "A model that, in addition to being available within Google Cloud, can also be exported (see ModelService.ExportModel) to a Jetson device afterwards." ] } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlVideoClassificationInputs" }, "GoogleCloudAiplatformV1beta1StoredContentsExample": { "properties": { "contentsExample": { "description": "Required. The example to be used with GenerateContent.", "$ref": "GoogleCloudAiplatformV1beta1ContentsExample" }, "searchKeyGenerationMethod": { "$ref": "GoogleCloudAiplatformV1beta1StoredContentsExampleSearchKeyGenerationMethod", "description": "Optional. The method used to generate the search key from `contents_example.contents`. This is ignored when uploading an example if `search_key` is provided." }, "searchKey": { "description": "Optional. (Optional) the search key used for retrieval. If not provided at upload-time, the search key will be generated from `contents_example.contents` using the method provided by `search_key_generation_method`. The generated search key will be included in retrieved examples.", "type": "string" } }, "description": "A ContentsExample to be used with GenerateContent alongside information required for storage and retrieval with Example Store.", "type": "object", "id": "GoogleCloudAiplatformV1beta1StoredContentsExample" }, "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestImportSchemaConfig": { "type": "object", "description": "Configuration for the input data format.", "id": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestImportSchemaConfig", "properties": { "dataFormatVersion": { "type": "string", "description": "Optional. Version of the data format." }, "dataFormat": { "description": "Required. The format of the input data.", "type": "string", "enum": [ "DATA_FORMAT_UNSPECIFIED", "OTEL_PROTO", "OTEL_JSON", "JSONL" ], "enumDescriptions": [ "Unspecified data format.", "OpenTelemetry Protobuf format (e.g. TracesData).", "OpenTelemetry JSON format.", "JSONL format mapping directly to EvaluationItem schema." ] } } }, "GoogleCloudAiplatformV1beta1GcsDestination": { "description": "The Google Cloud Storage location where the output is to be written to.", "properties": { "outputUriPrefix": { "description": "Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.", "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1GcsDestination" }, "GoogleCloudAiplatformV1beta1ExplainRequest": { "id": "GoogleCloudAiplatformV1beta1ExplainRequest", "description": "Request message for PredictionService.Explain.", "type": "object", "properties": { "parameters": { "type": "any", "description": "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." }, "instances": { "items": { "type": "any" }, "type": "array", "description": "Required. The instances that are the input to the explanation call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the explanation 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." }, "concurrentExplanationSpecOverride": { "description": "Optional. This field is the same as the one above, but supports multiple explanations to occur in parallel. The key can be any string. Each override will be run against the model, then its explanations will be grouped together. Note - these explanations are run **In Addition** to the default Explanation in the deployed model.", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1ExplanationSpecOverride" }, "type": "object" }, "explanationSpecOverride": { "$ref": "GoogleCloudAiplatformV1beta1ExplanationSpecOverride", "description": "If specified, overrides the explanation_spec of the DeployedModel. Can be used for explaining prediction results with different configurations, such as: - Explaining top-5 predictions results as opposed to top-1; - Increasing path count or step count of the attribution methods to reduce approximate errors; - Using different baselines for explaining the prediction results." }, "deployedModelId": { "type": "string", "description": "If specified, this ExplainRequest will be served by the chosen DeployedModel, overriding Endpoint.traffic_split." } } }, "GoogleCloudAiplatformV1beta1EvaluationRunMetricComputationBasedMetricSpec": { "type": "object", "id": "GoogleCloudAiplatformV1beta1EvaluationRunMetricComputationBasedMetricSpec", "properties": { "type": { "description": "Required. The type of the computation based metric.", "enum": [ "COMPUTATION_BASED_METRIC_TYPE_UNSPECIFIED", "EXACT_MATCH", "BLEU", "ROUGE" ], "enumDescriptions": [ "Unspecified computation based metric type.", "Exact match metric.", "BLEU metric.", "ROUGE metric." ], "type": "string" }, "parameters": { "type": "object", "description": "Optional. A map of parameters for the metric, e.g. {\"rouge_type\": \"rougeL\"}.", "additionalProperties": { "description": "Properties of the object.", "type": "any" } } }, "description": "Specification for a computation based metric." }, "GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfig": { "description": "Specification for a Memory Bank.", "properties": { "customizationConfigs": { "items": { "$ref": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfig" }, "type": "array", "description": "Optional. Configuration for how to customize Memory Bank behavior for a particular scope." }, "structuredMemoryConfigs": { "description": "Optional. Configuration for organizing structured memories for a particular scope.", "items": { "$ref": "GoogleCloudAiplatformV1beta1StructuredMemoryConfig" }, "type": "array" }, "similaritySearchConfig": { "description": "Optional. Configuration for how to perform similarity search on memories. If not set, the Memory Bank will use the default embedding model `text-embedding-005`.", "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigSimilaritySearchConfig" }, "ttlConfig": { "description": "Optional. Configuration for automatic TTL (\"time-to-live\") of the memories in the Memory Bank. If not set, TTL will not be applied automatically. The TTL can be explicitly set by modifying the `expire_time` of each Memory resource.", "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigTtlConfig" }, "generationConfig": { "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigGenerationConfig", "description": "Optional. Configuration for how to generate memories for the Memory Bank." }, "disableMemoryRevisions": { "description": "If true, no memory revisions will be created for any requests to the Memory Bank.", "type": "boolean" } }, "id": "GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfig", "type": "object" }, "GoogleCloudAiplatformV1beta1EnvVar": { "type": "object", "description": "Represents an environment variable present in a Container or Python Module.", "properties": { "name": { "description": "Required. Name of the environment variable. Must be a valid C identifier.", "type": "string" }, "value": { "description": "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.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1EnvVar" }, "GoogleCloudAiplatformV1beta1Metadata": { "properties": { "attributes": { "additionalProperties": { "type": "string", "format": "byte" }, "type": "object", "description": "Optional. Attributes attached to the data. The keys have semantic conventions and the consumers of the attributes should know how to deserialize the value bytes based on the keys." } }, "description": "Metadata for a chunk.", "type": "object", "id": "GoogleCloudAiplatformV1beta1Metadata" }, "GenaiVertexV1beta1GenerationConfig": { "properties": { "transcriptionConfig": { "description": "Optional. Configuration for speech recognition (transcription). If present, ASR is enabled.", "$ref": "GenaiVertexV1beta1TranscriptionConfig" }, "toolChoiceMode": { "description": "The mode of the tool choice.", "enum": [ "TOOL_CHOICE_TYPE_UNSPECIFIED", "AUTO", "ANY", "NONE", "VALIDATED" ], "enumDescriptions": [ "Default value. This value is unused.", "Auto tool choice.", "Any tool choice.", "No tool choice.", "Validated tool choice." ], "type": "string" }, "imageConfig": { "description": "Configuration for image interaction.", "deprecated": true, "$ref": "GenaiVertexV1beta1ImageConfig" }, "seed": { "format": "int32", "type": "integer", "description": "Seed used in decoding for reproducibility." }, "videoConfig": { "description": "Configuration for video generation.", "$ref": "GenaiVertexV1beta1VideoConfig" }, "thinkingSummaries": { "enumDescriptions": [ "Default value. This value is unused.", "Auto thinking summaries.", "No thinking summaries." ], "enum": [ "THINKING_SUMMARIES_UNSPECIFIED", "THINKING_SUMMARIES_AUTO", "THINKING_SUMMARIES_NONE" ], "type": "string", "description": "Whether to include thought summaries in the response." }, "topP": { "description": "The maximum cumulative probability of tokens to consider when sampling.", "format": "float", "type": "number" }, "maxOutputTokens": { "description": "The maximum number of tokens to include in the response.", "format": "int32", "type": "integer" }, "structuredSpeechConfig": { "$ref": "GenaiVertexV1beta1SpeakerConfig", "description": "Speech and multi-speaker configuration." }, "temperature": { "description": "Controls the randomness of the output.", "format": "float", "type": "number" }, "stopSequences": { "type": "array", "description": "A list of character sequences that will stop output interaction.", "items": { "type": "string" } }, "thinkingLevel": { "enumDescriptions": [ "Default value. This value is unused.", "Little to no thinking.", "Low thinking level.", "Medium thinking level.", "High thinking level." ], "enum": [ "THINKING_LEVEL_UNSPECIFIED", "THINKING_LEVEL_MINIMAL", "THINKING_LEVEL_LOW", "THINKING_LEVEL_MEDIUM", "THINKING_LEVEL_HIGH" ], "description": "The level of thought tokens that the model should generate.", "type": "string" }, "toolChoiceConfig": { "description": "The config for the tool choice.", "$ref": "GenaiVertexV1beta1ToolChoiceConfig" } }, "description": "Configuration parameters for model interactions.", "id": "GenaiVertexV1beta1GenerationConfig", "type": "object" }, "GenaiVertexV1beta1DocumentDelta": { "type": "object", "id": "GenaiVertexV1beta1DocumentDelta", "properties": { "data": { "type": "string", "format": "byte" }, "mimeType": { "enum": [ "TYPE_UNSPECIFIED", "TYPE_PDF", "TYPE_CSV" ], "type": "string", "enumDescriptions": [ "", "PDF document format", "CSV document format" ] }, "uri": { "type": "string" } } }, "GoogleCloudAiplatformV1beta1BlurBaselineConfig": { "id": "GoogleCloudAiplatformV1beta1BlurBaselineConfig", "description": "Config for blur baseline. When enabled, a linear path from the maximally blurred image to the input image is created. Using a blurred baseline instead of zero (black image) is motivated by the BlurIG approach explained here: https://arxiv.org/abs/2004.03383", "properties": { "maxBlurSigma": { "format": "float", "type": "number", "description": "The standard deviation of the blur kernel for the blurred baseline. The same blurring parameter is used for both the height and the width dimension. If not set, the method defaults to the zero (i.e. black for images) baseline." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1TextResponseFormat": { "properties": { "schema": { "type": "any", "description": "Optional. The JSON schema that the output should conform to. Only applicable when mime_type is APPLICATION_JSON." }, "mimeType": { "enumDescriptions": [ "Default value. This value is unused.", "JSON output format.", "Plain text output format." ], "description": "Optional. The IANA standard MIME type of the response.", "type": "string", "enum": [ "MIME_TYPE_UNSPECIFIED", "APPLICATION_JSON", "TEXT_PLAIN" ] } }, "type": "object", "description": "Configuration for text-specific output formatting.", "id": "GoogleCloudAiplatformV1beta1TextResponseFormat" }, "GoogleCloudAiplatformV1beta1TrajectoryPrecisionMetricValue": { "id": "GoogleCloudAiplatformV1beta1TrajectoryPrecisionMetricValue", "type": "object", "properties": { "score": { "format": "float", "description": "Output only. TrajectoryPrecision score.", "readOnly": true, "type": "number" } }, "description": "TrajectoryPrecision metric value for an instance." }, "GoogleCloudAiplatformV1beta1SchemaTextDatasetMetadata": { "type": "object", "description": "The metadata of Datasets that contain Text DataItems.", "properties": { "gcsBucket": { "description": "Google Cloud Storage Bucket name that contains the blob data of this Dataset.", "type": "string" }, "dataItemSchemaUri": { "type": "string", "description": "Points to a YAML file stored on Google Cloud Storage describing payload of the Text DataItems that belong to this Dataset." } }, "id": "GoogleCloudAiplatformV1beta1SchemaTextDatasetMetadata" }, "GoogleCloudAiplatformV1beta1TimeSeriesDataPoint": { "properties": { "tensor": { "description": "A tensor value.", "$ref": "GoogleCloudAiplatformV1beta1TensorboardTensor" }, "scalar": { "$ref": "GoogleCloudAiplatformV1beta1Scalar", "description": "A scalar value." }, "blobs": { "$ref": "GoogleCloudAiplatformV1beta1TensorboardBlobSequence", "description": "A blob sequence value." }, "step": { "description": "Step index of this data point within the run.", "type": "string", "format": "int64" }, "wallTime": { "format": "google-datetime", "type": "string", "description": "Wall clock timestamp when this data point is generated by the end user." } }, "type": "object", "description": "A TensorboardTimeSeries data point.", "id": "GoogleCloudAiplatformV1beta1TimeSeriesDataPoint" }, "GoogleCloudAiplatformV1beta1SchemaVideoDataItem": { "properties": { "mimeType": { "description": "Output only. The mime type of the content of the video. Only the videos in below listed mime types are supported. Supported mime_type: - video/mp4 - video/avi - video/quicktime", "readOnly": true, "type": "string" }, "gcsUri": { "description": "Required. Google Cloud Storage URI points to the original video in user's bucket. The video is up to 50 GB in size and up to 3 hour in duration.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1SchemaVideoDataItem", "type": "object", "description": "Payload of Video DataItem." }, "GoogleCloudAiplatformV1beta1OptimizePromptRequest": { "id": "GoogleCloudAiplatformV1beta1OptimizePromptRequest", "properties": { "content": { "$ref": "GoogleCloudAiplatformV1beta1Content", "description": "Required. The content of the prompt to optimize." }, "optimizationTarget": { "description": "Optional. The optimization strategy to use.", "enum": [ "OPTIMIZATION_TARGET_UNSPECIFIED", "OPTIMIZATION_TARGET_GENERAL", "OPTIMIZATION_TARGET_GEMINI_NANO", "OPTIMIZATION_TARGET_FEW_SHOT_RUBRICS", "OPTIMIZATION_TARGET_FEW_SHOT_TARGET_RESPONSE" ], "enumDescriptions": [ "Unspecified optimization target. Defaults to `OPTIMIZATION_TARGET_GENERAL`.", "Optimizes the prompt for quality using a zero-shot approach.", "Optimizes the prompt for Gemini Nano models.", "Optimizes the prompt using few-shot examples with rubrics.", "Optimizes the prompt using few-shot examples with a target response." ], "type": "string" } }, "type": "object", "description": "Request message for GenAiTuningService.OptimizePrompt." }, "GoogleCloudAiplatformV1beta1EvaluationParserConfig": { "id": "GoogleCloudAiplatformV1beta1EvaluationParserConfig", "properties": { "customCodeParserConfig": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationParserConfigCustomCodeParserConfig", "description": "Optional. Use custom code to parse the LLM response." } }, "type": "object", "description": "Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters." }, "GoogleCloudAiplatformV1beta1ShieldedVmConfig": { "description": "A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).", "properties": { "enableSecureBoot": { "type": "boolean", "description": "Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ShieldedVmConfig" }, "GoogleCloudAiplatformV1beta1A2aTaskArtifactChange": { "id": "GoogleCloudAiplatformV1beta1A2aTaskArtifactChange", "properties": { "artifact": { "description": "Required. The artifact that was added or updated.", "$ref": "GoogleCloudAiplatformV1beta1A2aTaskArtifact" }, "lastChunk": { "description": "Optional. Whether this is the last chunk of a streamed artifact.", "type": "boolean" }, "append": { "type": "boolean", "description": "Optional. Whether the artifact parts should be appended to an existing artifact rather than replacing it." } }, "description": "An event payload describing a change to one of the task's artifacts.", "type": "object" }, "GoogleCloudAiplatformV1beta1EnableModelRequest": { "description": "Request message for ModelGardenService.EnableModel.", "properties": { "service": { "deprecated": true, "type": "string", "description": "Optional. The ID links the Marketplace listing to the underlying Vertex AI model endpoint. Format: `services/{service_id}` Format: `services/{service_id}`" } }, "id": "GoogleCloudAiplatformV1beta1EnableModelRequest", "type": "object" }, "GoogleCloudAiplatformV1beta1ToolNameMatchResults": { "properties": { "toolNameMatchMetricValues": { "items": { "$ref": "GoogleCloudAiplatformV1beta1ToolNameMatchMetricValue" }, "type": "array", "description": "Output only. Tool name match metric values.", "readOnly": true } }, "id": "GoogleCloudAiplatformV1beta1ToolNameMatchResults", "type": "object", "description": "Results for tool name match metric." }, "GoogleCloudAiplatformV1beta1SchemaImageDatasetMetadata": { "id": "GoogleCloudAiplatformV1beta1SchemaImageDatasetMetadata", "description": "The metadata of Datasets that contain Image DataItems.", "type": "object", "properties": { "dataItemSchemaUri": { "type": "string", "description": "Points to a YAML file stored on Google Cloud Storage describing payload of the Image DataItems that belong to this Dataset." }, "gcsBucket": { "description": "Google Cloud Storage Bucket name that contains the blob data of this Dataset.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1SchemaTimeSeriesDatasetMetadata": { "id": "GoogleCloudAiplatformV1beta1SchemaTimeSeriesDatasetMetadata", "type": "object", "description": "The metadata of Datasets that contain time series data.", "properties": { "inputConfig": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTimeSeriesDatasetMetadataInputConfig" }, "timeSeriesIdentifierColumn": { "description": "The column name of the time series identifier column that identifies the time series.", "type": "string" }, "timeColumn": { "type": "string", "description": "The column name of the time column that identifies time order in the time series." } } }, "GoogleCloudAiplatformV1beta1ListOptimalTrialsRequest": { "description": "Request message for VizierService.ListOptimalTrials.", "type": "object", "id": "GoogleCloudAiplatformV1beta1ListOptimalTrialsRequest", "properties": {} }, "GenaiVertexV1beta1RagStoreConfigRagResource": { "properties": { "ragFileIds": { "description": "Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.", "type": "array", "items": { "type": "string" } }, "ragCorpus": { "type": "string", "description": "Optional. RagCorpora resource name." } }, "id": "GenaiVertexV1beta1RagStoreConfigRagResource", "type": "object", "description": "The definition of the Rag resource." }, "GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingLlmRanker": { "id": "GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingLlmRanker", "type": "object", "description": "Config for LlmRanker.", "properties": { "modelName": { "type": "string", "description": "Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models)." } } }, "GoogleCloudAiplatformV1beta1GoogleMaps": { "description": "Tool to retrieve public maps data for grounding, powered by Google.", "properties": { "groundingTypes": { "$ref": "GoogleCloudAiplatformV1beta1GoogleMapsGroundingTypes", "description": "Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset." }, "enableWidget": { "deprecated": true, "type": "boolean", "description": "Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response." } }, "id": "GoogleCloudAiplatformV1beta1GoogleMaps", "type": "object" }, "GoogleCloudAiplatformV1beta1PairwiseSummarizationQualityResult": { "properties": { "pairwiseChoice": { "type": "string", "enumDescriptions": [ "Unspecified prediction choice.", "Baseline prediction wins", "Candidate prediction wins", "Winner cannot be determined" ], "enum": [ "PAIRWISE_CHOICE_UNSPECIFIED", "BASELINE", "CANDIDATE", "TIE" ], "readOnly": true, "description": "Output only. Pairwise summarization prediction choice." }, "confidence": { "description": "Output only. Confidence for summarization quality score.", "type": "number", "format": "float", "readOnly": true }, "explanation": { "readOnly": true, "type": "string", "description": "Output only. Explanation for summarization quality score." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1PairwiseSummarizationQualityResult", "description": "Spec for pairwise summarization quality result." }, "GoogleCloudAiplatformV1beta1TimeSeriesData": { "properties": { "tensorboardTimeSeriesId": { "type": "string", "description": "Required. The ID of the TensorboardTimeSeries, which will become the final component of the TensorboardTimeSeries' resource name" }, "values": { "items": { "$ref": "GoogleCloudAiplatformV1beta1TimeSeriesDataPoint" }, "type": "array", "description": "Required. Data points in this time series." }, "valueType": { "type": "string", "enumDescriptions": [ "The value type is unspecified.", "Used for TensorboardTimeSeries that is a list of scalars. E.g. accuracy of a model over epochs/time.", "Used for TensorboardTimeSeries that is a list of tensors. E.g. histograms of weights of layer in a model over epoch/time.", "Used for TensorboardTimeSeries that is a list of blob sequences. E.g. set of sample images with labels over epochs/time." ], "enum": [ "VALUE_TYPE_UNSPECIFIED", "SCALAR", "TENSOR", "BLOB_SEQUENCE" ], "description": "Required. Immutable. The value type of this time series. All the values in this time series data must match this value type." } }, "id": "GoogleCloudAiplatformV1beta1TimeSeriesData", "description": "All the data stored in a TensorboardTimeSeries.", "type": "object" }, "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigVertexPredictionEndpoint": { "description": "Config representing a model hosted on Vertex Prediction Endpoint.", "id": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigVertexPredictionEndpoint", "properties": { "modelVersionId": { "type": "string", "description": "Output only. Version ID of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model.", "readOnly": true }, "endpoint": { "description": "Required. The endpoint resource name. Format: `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` or `projects/{project}/locations/{location}/endpoints/{endpoint}`", "type": "string" }, "model": { "type": "string", "description": "Output only. The resource name of the model that is deployed on the endpoint. Present only when the endpoint is not a publisher model. Pattern: `projects/{project}/locations/{location}/models/{model}`", "readOnly": true } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GenerateMemoriesRequest": { "id": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequest", "type": "object", "description": "Request message for MemoryBankService.GenerateMemories. Maximum size is 8 MB.", "properties": { "scope": { "description": "Optional. The scope of the memories that should be generated. Memories will be consolidated across memories with the same scope. Must be provided unless the scope is defined in the source content. If `scope` is provided, it will override the scope defined in the source content. Scope values cannot contain the wildcard character '*'.", "type": "object", "additionalProperties": { "type": "string" } }, "revisionTtl": { "format": "google-duration", "description": "Optional. The TTL for the revision. The expiration time is computed: now + TTL.", "type": "string" }, "revisionExpireTime": { "description": "Optional. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.", "type": "string", "format": "google-datetime" }, "directMemoriesSource": { "$ref": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequestDirectMemoriesSource", "description": "Defines a direct source of memories that should be uploaded to Memory Bank. This is similar to `CreateMemory`, but it allows for consolidation between these new memories and existing memories for the same scope." }, "vertexSessionSource": { "description": "Defines a Vertex Session as the source content from which to generate memories.", "$ref": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequestVertexSessionSource" }, "revisionLabels": { "description": "Optional. Labels to be applied to the generated memory revisions. For example, you can use this to label a revision with its data source.", "additionalProperties": { "type": "string" }, "type": "object" }, "metadataMergeStrategy": { "type": "string", "enum": [ "METADATA_MERGE_STRATEGY_UNSPECIFIED", "OVERWRITE", "MERGE", "REQUIRE_EXACT_MATCH" ], "description": "Optional. The strategy to use when applying metadata to existing memories.", "enumDescriptions": [ "Unspecified metadata merge strategy. If unspecified, the default behavior is to overwrite existing metadata (`OVERWRITE`).", "Replace the metadata of the updated memories with the new metadata.", "Append new metadata to the existing metadata. If there are duplicate keys, the existing values will be overwritten.", "Restrict consolidation to memories that have exactly the same metadata as the request. If a memory doesn't have the same metadata, it is not eligible for consolidation." ] }, "disableConsolidation": { "type": "boolean", "description": "Optional. If true, generated memories will not be consolidated with existing memories; all generated memories will be added as new memories regardless of whether they are duplicates of or contradictory to existing memories. By default, memory consolidation is enabled." }, "metadata": { "description": "Optional. User-provided metadata for the generated memories. This is not generated by Memory Bank.", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1MemoryMetadataValue" }, "type": "object" }, "directContentsSource": { "description": "Defines a direct source of content as the source content from which to generate memories.", "$ref": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequestDirectContentsSource" }, "disableMemoryRevisions": { "type": "boolean", "description": "Optional. If true, no revisions will be created for this request." }, "allowedTopics": { "type": "array", "description": "Optional. Restricts memory generation to a subset of memory topics.", "items": { "$ref": "GoogleCloudAiplatformV1beta1MemoryTopicId" } } } }, "GoogleCloudAiplatformV1beta1StreamingPredictResponse": { "id": "GoogleCloudAiplatformV1beta1StreamingPredictResponse", "type": "object", "properties": { "parameters": { "$ref": "GoogleCloudAiplatformV1beta1Tensor", "description": "The parameters that govern the prediction." }, "outputs": { "description": "The prediction output.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Tensor" } } }, "description": "Response message for PredictionService.StreamingPredict." }, "GenaiVertexV1beta1Content": { "type": "object", "description": "The content of the response.", "id": "GenaiVertexV1beta1Content", "properties": { "image": { "$ref": "GenaiVertexV1beta1ImageContent" }, "audio": { "$ref": "GenaiVertexV1beta1AudioContent" }, "toolCall": { "$ref": "GenaiVertexV1beta1ToolCallContent", "deprecated": true }, "text": { "$ref": "GenaiVertexV1beta1TextContent" }, "video": { "$ref": "GenaiVertexV1beta1VideoContent" }, "document": { "$ref": "GenaiVertexV1beta1DocumentContent" }, "thought": { "deprecated": true, "$ref": "GenaiVertexV1beta1ThoughtContent" }, "toolResult": { "deprecated": true, "$ref": "GenaiVertexV1beta1ToolResultContent" } } }, "GoogleCloudAiplatformV1beta1SafetyInput": { "id": "GoogleCloudAiplatformV1beta1SafetyInput", "properties": { "metricSpec": { "$ref": "GoogleCloudAiplatformV1beta1SafetySpec", "description": "Required. Spec for safety metric." }, "instance": { "description": "Required. Safety instance.", "$ref": "GoogleCloudAiplatformV1beta1SafetyInstance" } }, "description": "Input for safety metric.", "type": "object" }, "GoogleCloudAiplatformV1beta1TaskStatusDetailsChange": { "type": "object", "id": "GoogleCloudAiplatformV1beta1TaskStatusDetailsChange", "properties": { "newTaskStatus": { "$ref": "GoogleCloudAiplatformV1beta1TaskStatusDetails", "description": "Required. The complete state of the task's status *after* the change." } }, "description": "Represents a change to the task's status details." }, "GoogleCloudAiplatformV1beta1SuggestTrialsResponse": { "id": "GoogleCloudAiplatformV1beta1SuggestTrialsResponse", "type": "object", "properties": { "studyState": { "description": "The state of the Study.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE", "COMPLETED" ], "enumDescriptions": [ "The study state is unspecified.", "The study is active.", "The study is stopped due to an internal error.", "The study is done when the service exhausts the parameter search space or max_trial_count is reached." ] }, "trials": { "description": "A list of Trials.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Trial" }, "type": "array" }, "startTime": { "type": "string", "format": "google-datetime", "description": "The time at which the operation was started." }, "endTime": { "type": "string", "description": "The time at which operation processing completed.", "format": "google-datetime" } }, "description": "Response message for VizierService.SuggestTrials." }, "GoogleCloudAiplatformV1beta1FeatureView": { "description": "FeatureView is representation of values that the FeatureOnlineStore will serve based on its syncConfig.", "type": "object", "properties": { "bigQuerySource": { "$ref": "GoogleCloudAiplatformV1beta1FeatureViewBigQuerySource", "description": "Optional. Configures how data is supposed to be extracted from a BigQuery source to be loaded onto the FeatureOnlineStore." }, "name": { "description": "Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", "type": "string" }, "serviceAccountEmail": { "readOnly": true, "description": "Output only. A Service Account unique to this FeatureView. The role bigquery.dataViewer should be granted to this service account to allow Vertex AI Feature Store to sync data to the online store.", "type": "string" }, "vertexRagSource": { "$ref": "GoogleCloudAiplatformV1beta1FeatureViewVertexRagSource", "description": "Optional. The Vertex RAG Source that the FeatureView is linked to." }, "satisfiesPzs": { "readOnly": true, "type": "boolean", "description": "Output only. Reserved for future use." }, "bigtableMetadata": { "$ref": "GoogleCloudAiplatformV1beta1FeatureViewBigtableMetadata", "readOnly": true, "description": "Output only. Metadata containing information about the Cloud Bigtable." }, "createTime": { "type": "string", "readOnly": true, "description": "Output only. Timestamp when this FeatureView was created.", "format": "google-datetime" }, "serviceAgentType": { "enum": [ "SERVICE_AGENT_TYPE_UNSPECIFIED", "SERVICE_AGENT_TYPE_PROJECT", "SERVICE_AGENT_TYPE_FEATURE_VIEW" ], "description": "Optional. Service agent type used during data sync. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureView within a project, a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_VIEW`. This will generate a separate service account to access the BigQuery source table.", "enumDescriptions": [ "By default, the project-level Vertex AI Service Agent is enabled.", "Indicates the project-level Vertex AI Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) will be used during sync jobs.", "Enable a FeatureView service account to be created by Vertex AI and output in the field `service_account_email`. This service account will be used to read from the source BigQuery table during sync." ], "type": "string" }, "satisfiesPzi": { "type": "boolean", "description": "Output only. Reserved for future use.", "readOnly": true }, "updateTime": { "description": "Output only. Timestamp when this FeatureView was last updated.", "format": "google-datetime", "type": "string", "readOnly": true }, "indexConfig": { "description": "Optional. Configuration for index preparation for vector search. It contains the required configurations to create an index from source data, so that approximate nearest neighbor (a.k.a ANN) algorithms search can be performed during online serving.", "$ref": "GoogleCloudAiplatformV1beta1FeatureViewIndexConfig" }, "etag": { "type": "string", "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens." }, "syncConfig": { "description": "Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving.", "$ref": "GoogleCloudAiplatformV1beta1FeatureViewSyncConfig" }, "optimizedConfig": { "description": "Optional. Configuration for FeatureView created under Optimized FeatureOnlineStore.", "$ref": "GoogleCloudAiplatformV1beta1FeatureViewOptimizedConfig" }, "featureRegistrySource": { "description": "Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore.", "$ref": "GoogleCloudAiplatformV1beta1FeatureViewFeatureRegistrySource" }, "vectorSearchConfig": { "$ref": "GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfig", "description": "Optional. Deprecated: please use FeatureView.index_config instead.", "deprecated": true }, "labels": { "additionalProperties": { "type": "string" }, "description": "Optional. The labels with user-defined metadata to organize your FeatureViews. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureOnlineStore(System labels are excluded).\" System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable.", "type": "object" } }, "id": "GoogleCloudAiplatformV1beta1FeatureView" }, "GoogleCloudAiplatformV1beta1ApiAuth": { "type": "object", "description": "The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead.", "properties": { "apiKeyConfig": { "$ref": "GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig", "description": "The API secret." } }, "id": "GoogleCloudAiplatformV1beta1ApiAuth" }, "GoogleCloudAiplatformV1beta1Artifact": { "id": "GoogleCloudAiplatformV1beta1Artifact", "description": "Instance of a general artifact.", "properties": { "schemaVersion": { "type": "string", "description": "The version of the schema in schema_name to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store." }, "name": { "type": "string", "readOnly": true, "description": "Output only. The resource name of the Artifact." }, "updateTime": { "description": "Output only. Timestamp when this Artifact was last updated.", "type": "string", "format": "google-datetime", "readOnly": true }, "metadata": { "type": "object", "description": "Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "displayName": { "description": "User provided display name of the Artifact. May be up to 128 Unicode characters.", "type": "string" }, "etag": { "description": "An eTag used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", "type": "string" }, "state": { "type": "string", "description": "The state of this Artifact. This is a property of the Artifact, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines), and the system does not prescribe or check the validity of state transitions.", "enum": [ "STATE_UNSPECIFIED", "PENDING", "LIVE" ], "enumDescriptions": [ "Unspecified state for the Artifact.", "A state used by systems like Vertex AI Pipelines to indicate that the underlying data item represented by this Artifact is being created.", "A state indicating that the Artifact should exist, unless something external to the system deletes it." ] }, "description": { "type": "string", "description": "Description of the Artifact" }, "uri": { "type": "string", "description": "The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file." }, "labels": { "type": "object", "description": "The labels with user-defined metadata to organize your Artifacts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Artifact (System labels are excluded).", "additionalProperties": { "type": "string" } }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when this Artifact was created." }, "schemaTitle": { "description": "The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ErrorAnalysisAnnotationAttributedItem": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ErrorAnalysisAnnotationAttributedItem", "properties": { "distance": { "format": "double", "description": "The distance of this item to the annotation.", "type": "number" }, "annotationResourceName": { "type": "string", "description": "The unique ID for each annotation. Used by FE to allocate the annotation in DB." } }, "description": "Attributed items for a given annotation, typically representing neighbors from the training sets constrained by the query type." }, "GoogleCloudAiplatformV1beta1SchemaPromptSpecTranslationGcsInputSource": { "id": "GoogleCloudAiplatformV1beta1SchemaPromptSpecTranslationGcsInputSource", "properties": { "inputUri": { "description": "Source data URI. For example, `gs://my_bucket/my_object`.", "type": "string" } }, "type": "object" }, "CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig": { "properties": { "enable": { "description": "Optional. If true, enable alignment.", "type": "boolean" } }, "type": "object", "id": "CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig", "description": "Configuration for color alignment." }, "GoogleCloudAiplatformV1beta1AggregationResult": { "id": "GoogleCloudAiplatformV1beta1AggregationResult", "description": "The aggregation result for a single metric.", "type": "object", "properties": { "exactMatchMetricValue": { "description": "Results for exact match metric.", "$ref": "GoogleCloudAiplatformV1beta1ExactMatchMetricValue" }, "rougeMetricValue": { "description": "Results for rouge metric.", "$ref": "GoogleCloudAiplatformV1beta1RougeMetricValue" }, "pointwiseMetricResult": { "description": "Result for pointwise metric.", "$ref": "GoogleCloudAiplatformV1beta1PointwiseMetricResult" }, "customCodeExecutionResult": { "description": "Result for code execution metric.", "$ref": "GoogleCloudAiplatformV1beta1CustomCodeExecutionResult" }, "bleuMetricValue": { "description": "Results for bleu metric.", "$ref": "GoogleCloudAiplatformV1beta1BleuMetricValue" }, "aggregationMetric": { "enumDescriptions": [ "Unspecified aggregation metric.", "Average aggregation metric. Not supported for Pairwise metric.", "Mode aggregation metric.", "Standard deviation aggregation metric. Not supported for pairwise metric.", "Variance aggregation metric. Not supported for pairwise metric.", "Minimum aggregation metric. Not supported for pairwise metric.", "Maximum aggregation metric. Not supported for pairwise metric.", "Median aggregation metric. Not supported for pairwise metric.", "90th percentile aggregation metric. Not supported for pairwise metric.", "95th percentile aggregation metric. Not supported for pairwise metric.", "99th percentile aggregation metric. Not supported for pairwise metric." ], "enum": [ "AGGREGATION_METRIC_UNSPECIFIED", "AVERAGE", "MODE", "STANDARD_DEVIATION", "VARIANCE", "MINIMUM", "MAXIMUM", "MEDIAN", "PERCENTILE_P90", "PERCENTILE_P95", "PERCENTILE_P99" ], "description": "Aggregation metric.", "type": "string" }, "pairwiseMetricResult": { "$ref": "GoogleCloudAiplatformV1beta1PairwiseMetricResult", "description": "Result for pairwise metric." } } }, "GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigClientToAgentConfig": { "type": "object", "properties": { "agentGateway": { "description": "Required. The resource name of the Agent Gateway to use for inbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `CLIENT_TO_AGENT`. Format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}`", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigClientToAgentConfig", "description": "Configuration for traffic targeting a Reasoning Engine." }, "GoogleCloudAiplatformV1beta1GroundingChunkWeb": { "type": "object", "id": "GoogleCloudAiplatformV1beta1GroundingChunkWeb", "description": "A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information.", "properties": { "title": { "type": "string", "description": "The title of the web page that contains the evidence." }, "uri": { "description": "The URI of the web page that contains the evidence.", "type": "string" }, "domain": { "type": "string", "description": "The domain of the web page that contains the evidence. This can be used to filter out low-quality sources." } } }, "GoogleIamV1TestIamPermissionsResponse": { "type": "object", "id": "GoogleIamV1TestIamPermissionsResponse", "properties": { "permissions": { "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", "type": "array", "items": { "type": "string" } } }, "description": "Response message for `TestIamPermissions` method." }, "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveSpecDataDriftSpec": { "type": "object", "description": "Data drift monitoring spec. Data drift measures the distribution distance between the current dataset and a baseline dataset. A typical use case is to detect data drift between the recent production serving dataset and the training dataset, or to compare the recent production dataset with a dataset from a previous period.", "id": "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveSpecDataDriftSpec", "properties": { "featureAlertConditions": { "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringAlertCondition" }, "type": "object", "description": "Per feature alert condition will override default alert condition." }, "defaultCategoricalAlertCondition": { "description": "Default alert condition for all the categorical features.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringAlertCondition" }, "categoricalMetricType": { "description": "Supported metrics type: * l_infinity * jensen_shannon_divergence", "type": "string" }, "features": { "type": "array", "items": { "type": "string" }, "description": "Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used." }, "numericMetricType": { "description": "Supported metrics type: * jensen_shannon_divergence", "type": "string" }, "defaultNumericAlertCondition": { "description": "Default alert condition for all the numeric features.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringAlertCondition" } } }, "GoogleCloudAiplatformV1beta1ListBatchPredictionJobsResponse": { "type": "object", "description": "Response message for JobService.ListBatchPredictionJobs", "id": "GoogleCloudAiplatformV1beta1ListBatchPredictionJobsResponse", "properties": { "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results. Pass to ListBatchPredictionJobsRequest.page_token to obtain that page." }, "batchPredictionJobs": { "items": { "$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob" }, "type": "array", "description": "List of BatchPredictionJobs in the requested page." } } }, "GoogleCloudAiplatformV1beta1CheckTrialEarlyStoppingStateResponse": { "type": "object", "id": "GoogleCloudAiplatformV1beta1CheckTrialEarlyStoppingStateResponse", "properties": { "shouldStop": { "description": "True if the Trial should stop.", "type": "boolean" } }, "description": "Response message for VizierService.CheckTrialEarlyStoppingState." }, "GoogleCloudAiplatformV1beta1StoredContentsExampleSearchKeyGenerationMethodLastEntry": { "id": "GoogleCloudAiplatformV1beta1StoredContentsExampleSearchKeyGenerationMethodLastEntry", "type": "object", "properties": {}, "description": "Configuration for using only the last entry of the conversation history as the search key." }, "GoogleCloudAiplatformV1beta1TuningJobMetadata": { "properties": { "completedStepCount": { "description": "Output only. The number of steps that have been completed. Set for Multi-Step RL.", "format": "int64", "type": "string", "readOnly": true }, "completedEpochCount": { "format": "int64", "type": "string", "readOnly": true, "description": "Output only. The number of epochs that have been completed." } }, "description": "Tuning job metadata.", "id": "GoogleCloudAiplatformV1beta1TuningJobMetadata", "type": "object" }, "GoogleCloudAiplatformV1beta1BatchCreateRagDataSchemasRequest": { "properties": { "requests": { "description": "Required. The request messages for VertexRagDataService.CreateRagDataSchema. A maximum of 500 schemas can be created in a batch.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1CreateRagDataSchemaRequest" } } }, "id": "GoogleCloudAiplatformV1beta1BatchCreateRagDataSchemasRequest", "description": "Request message for VertexRagDataService.BatchCreateRagDataSchemas.", "type": "object" }, "GoogleCloudAiplatformV1beta1GenerateVideoResponse": { "description": "Generate video response.", "properties": { "generatedSamples": { "deprecated": true, "items": { "type": "string" }, "type": "array", "description": "The cloud storage uris of the generated videos." }, "raiMediaFilteredCount": { "description": "Returns if any videos were filtered due to RAI policies.", "format": "int32", "type": "integer" }, "raiMediaFilteredReasons": { "description": "Returns rai failure reasons if any.", "items": { "type": "string" }, "type": "array" }, "videos": { "description": "List of video bytes or Cloud Storage URIs of the generated videos.", "items": { "$ref": "GoogleCloudAiplatformV1beta1GenerateVideoResponseVideo" }, "type": "array" } }, "id": "GoogleCloudAiplatformV1beta1GenerateVideoResponse", "type": "object" }, "GoogleCloudAiplatformV1beta1CitationMetadata": { "description": "A collection of citations that apply to a piece of generated content.", "properties": { "citations": { "description": "Output only. A list of citations for the content.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Citation" }, "type": "array", "readOnly": true } }, "id": "GoogleCloudAiplatformV1beta1CitationMetadata", "type": "object" }, "GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorerExactMatchScorer": { "description": "Scores autorater responses by using exact string match reward scorer.", "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorerExactMatchScorer", "properties": { "correctAnswerReward": { "description": "Assigns this reward score if the parsed response string equals the expression.", "format": "float", "type": "number" }, "wrongAnswerReward": { "type": "number", "description": "Assigns this reward score if the parsed reward value does not equal the expression.", "format": "float" }, "expression": { "type": "string", "description": "The string expression to match against for scoring. This field supports placeholders in the format of {{references.key}} that will be replaced before matching. Regex is not supported for this expression. For example, users can define an ExactMatchScorer as follows: { \"correctAnswerReward\": 1.0, \"wrongAnswerReward\": -1.0, \"expression\": \"{{references.concise_answer}}\" } When evaluating the reward for each parsed autorater response, if the prompt references in the training/validation dataset has the following fields: ``` { \"example\": ..., \"references\": { \"concise_ansser\": \"Yes\", \"verbose_answer\": \"The answer is Yes\" } } ``` The above ExactMatchScorer will be replaced as follows for scoring: ``` { \"correctAnswerReward\": 1.0, \"wrongAnswerReward\": -1.0, \"expression\": \"Yes\" } ``` If the *parsed* autorater response is equal to the string `\"Yes\"`, then the reward is `1.0`, otherwise the reward is `-1.0`." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1UpdateModelMonitorOperationMetadata": { "description": "Runtime operation information for ModelMonitoringService.UpdateModelMonitor.", "properties": { "genericMetadata": { "description": "The operation generic information.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1UpdateModelMonitorOperationMetadata" }, "GenaiVertexV1beta1FunctionResultDelta": { "type": "object", "properties": { "result": { "$ref": "GenaiVertexV1beta1Value" }, "name": { "type": "string" }, "isError": { "type": "boolean" } }, "id": "GenaiVertexV1beta1FunctionResultDelta" }, "GoogleCloudAiplatformV1beta1ExportFeatureValuesRequestSnapshotExport": { "properties": { "startTime": { "format": "google-datetime", "description": "Excludes Feature values with feature generation timestamp before this timestamp. If not set, retrieve oldest values kept in Feature Store. Timestamp, if present, must not have higher than millisecond precision.", "type": "string" }, "snapshotTime": { "format": "google-datetime", "description": "Exports Feature values as of this timestamp. If not set, retrieve values as of now. Timestamp, if present, must not have higher than millisecond precision.", "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ExportFeatureValuesRequestSnapshotExport", "description": "Describes exporting the latest Feature values of all entities of the EntityType between [start_time, snapshot_time]." }, "GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfigBruteForceConfig": { "properties": {}, "type": "object", "id": "GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfigBruteForceConfig" }, "GoogleCloudAiplatformV1beta1NearestNeighborQueryNumericFilter": { "description": "Numeric filter is used to search a subset of the entities by using boolean rules on numeric columns. For example: Database Point 0: {name: \"a\" value_int: 42} {name: \"b\" value_float: 1.0} Database Point 1: {name: \"a\" value_int: 10} {name: \"b\" value_float: 2.0} Database Point 2: {name: \"a\" value_int: -1} {name: \"b\" value_float: 3.0} Query: {name: \"a\" value_int: 12 operator: LESS} // Matches Point 1, 2 {name: \"b\" value_float: 2.0 operator: EQUAL} // Matches Point 1", "id": "GoogleCloudAiplatformV1beta1NearestNeighborQueryNumericFilter", "properties": { "valueDouble": { "format": "double", "type": "number", "description": "double value type." }, "valueFloat": { "description": "float value type.", "type": "number", "format": "float" }, "name": { "description": "Required. Column name in BigQuery that used as filters.", "type": "string" }, "valueInt": { "description": "int value type.", "format": "int64", "type": "string" }, "op": { "enum": [ "OPERATOR_UNSPECIFIED", "LESS", "LESS_EQUAL", "EQUAL", "GREATER_EQUAL", "GREATER", "NOT_EQUAL" ], "enumDescriptions": [ "Unspecified operator.", "Entities are eligible if their value is \u003c the query's.", "Entities are eligible if their value is \u003c= the query's.", "Entities are eligible if their value is == the query's.", "Entities are eligible if their value is \u003e= the query's.", "Entities are eligible if their value is \u003e the query's.", "Entities are eligible if their value is != the query's." ], "description": "Optional. This MUST be specified for queries and must NOT be specified for database points.", "type": "string" } }, "type": "object" }, "GenaiVertexV1beta1CodeExecutionCallDelta": { "type": "object", "id": "GenaiVertexV1beta1CodeExecutionCallDelta", "properties": { "arguments": { "$ref": "GenaiVertexV1beta1CodeExecutionCallContentCodeExecutionCallArguments" } } }, "GoogleCloudAiplatformV1beta1TimestampSplit": { "id": "GoogleCloudAiplatformV1beta1TimestampSplit", "description": "Assigns input data to training, validation, and test sets based on a provided timestamps. The youngest data pieces are assigned to training set, next to validation set, and the oldest to the test set. Supported only for tabular Datasets.", "type": "object", "properties": { "testFraction": { "format": "double", "type": "number", "description": "The fraction of the input data that is to be used to evaluate the Model." }, "trainingFraction": { "description": "The fraction of the input data that is to be used to train the Model.", "type": "number", "format": "double" }, "key": { "description": "Required. The key is a name of one of the Dataset's data columns. The values of the key (the values in the column) must be in RFC 3339 `date-time` format, where `time-offset` = `\"Z\"` (e.g. 1985-04-12T23:20:50.52Z). If for a piece of data the key is not present or has an invalid value, that piece is ignored by the pipeline.", "type": "string" }, "validationFraction": { "format": "double", "description": "The fraction of the input data that is to be used to validate the Model.", "type": "number" } } }, "GoogleCloudAiplatformV1beta1GoogleDriveSourceResourceId": { "properties": { "resourceId": { "type": "string", "description": "Required. The ID of the Google Drive resource." }, "resourceType": { "description": "Required. The type of the Google Drive resource.", "enum": [ "RESOURCE_TYPE_UNSPECIFIED", "RESOURCE_TYPE_FILE", "RESOURCE_TYPE_FOLDER" ], "enumDescriptions": [ "Unspecified resource type.", "File resource type.", "Folder resource type." ], "type": "string" } }, "description": "The type and ID of the Google Drive resource.", "type": "object", "id": "GoogleCloudAiplatformV1beta1GoogleDriveSourceResourceId" }, "GoogleCloudAiplatformV1beta1CorroborateContentRequestParameters": { "properties": { "citationThreshold": { "type": "number", "format": "double", "description": "Optional. Only return claims with citation score larger than the threshold." } }, "description": "Parameters that can be overrided per request.", "id": "GoogleCloudAiplatformV1beta1CorroborateContentRequestParameters", "type": "object" }, "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentData": { "description": "Deprecated: Use `agent_eval_data` instead. Contains data specific to agent evaluations.", "id": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentData", "type": "object", "properties": { "agentConfig": { "description": "Optional. Deprecated: Use `agent_eval_data` instead. Agent configuration.", "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentConfig" }, "developerInstruction": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData", "deprecated": true, "description": "Optional. Deprecated: Use `agents.developer_instruction` or `turns.events.active_instruction` instead. A field containing instructions from the developer for the agent." }, "tools": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentDataTools", "description": "List of tools.", "deprecated": true }, "agents": { "description": "Optional. The static Agent Configuration. This map defines the graph structure of the agent system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent (tools, instructions, sub-agents).", "type": "object", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentConfig" } }, "toolsText": { "type": "string", "deprecated": true, "description": "A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters." }, "events": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentDataEvents", "description": "A list of events." }, "turns": { "items": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentDataConversationTurn" }, "description": "Optional. The chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -\u003e Agent Response).", "type": "array" } }, "deprecated": true }, "GoogleCloudAiplatformV1beta1AppendA2aTaskEventsRequest": { "properties": { "events": { "type": "array", "description": "Optional. The events to append. Used only if the parent is a TaskStore.", "items": { "$ref": "GoogleCloudAiplatformV1beta1A2aTaskEvent" } }, "generation": { "format": "int64", "type": "string", "description": "Optional. The current task generation." }, "taskEvents": { "description": "Required. The events to append. The number of events to append must be less than or equal to 100. Otherwise, an exception will be thrown. Used only if the parent is a ReasoningEngine.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1TaskEvent" } } }, "description": "Request message for AppendA2aTaskEvents.", "type": "object", "id": "GoogleCloudAiplatformV1beta1AppendA2aTaskEventsRequest" }, "GoogleCloudAiplatformV1beta1GenerationConfig": { "type": "object", "properties": { "responseModalities": { "type": "array", "description": "Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.", "items": { "enum": [ "MODALITY_UNSPECIFIED", "TEXT", "IMAGE", "AUDIO", "VIDEO" ], "enumDescriptions": [ "Unspecified modality. Will be processed as text.", "Text modality.", "Image modality.", "Audio modality.", "Video modality." ], "type": "string" } }, "topK": { "description": "Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.", "format": "float", "type": "number" }, "responseMimeType": { "type": "string", "description": "Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. Deprecated: Use `response_format` instead.", "deprecated": true }, "thinkingConfig": { "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig", "description": "Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking." }, "candidateCount": { "description": "Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.", "type": "integer", "format": "int32" }, "audioTimestamp": { "type": "boolean", "description": "Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response." }, "mediaResolution": { "type": "string", "enum": [ "MEDIA_RESOLUTION_UNSPECIFIED", "MEDIA_RESOLUTION_LOW", "MEDIA_RESOLUTION_MEDIUM", "MEDIA_RESOLUTION_HIGH" ], "enumDescriptions": [ "Media resolution has not been set.", "Media resolution set to low (64 tokens).", "Media resolution set to medium (256 tokens).", "Media resolution set to high (zoomed reframing with 256 tokens)." ], "description": "Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model." }, "logprobs": { "description": "Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.", "type": "integer", "format": "int32" }, "routingConfig": { "description": "Optional. Routing configuration.", "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig" }, "modelConfig": { "deprecated": true, "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigModelConfig", "description": "Optional. Config for model selection." }, "seed": { "format": "int32", "type": "integer", "description": "Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the \"random\" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results." }, "translationConfig": { "description": "Optional. Config for translation.", "$ref": "GoogleCloudAiplatformV1beta1TranslationConfig" }, "maxOutputTokens": { "type": "integer", "format": "int32", "description": "Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses." }, "topP": { "format": "float", "description": "Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.", "type": "number" }, "responseLogprobs": { "description": "Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.", "type": "boolean" }, "temperature": { "format": "float", "type": "number", "description": "Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]." }, "stopSequences": { "items": { "type": "string" }, "type": "array", "description": "Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use [\"\\n\", \"###\"] to stop generation at a new line or a specific marker." }, "frequencyPenalty": { "format": "float", "type": "number", "description": "Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]." }, "audioTranscriptionConfig": { "$ref": "GoogleCloudAiplatformV1beta1AudioTranscriptionConfig", "description": "Optional. Configuration for audio transcription (speech recognition)." }, "responseFormat": { "items": { "$ref": "GoogleCloudAiplatformV1beta1ResponseFormat" }, "type": "array", "description": "Optional. New response format field for the model to configure output formatting and delivery." }, "imageConfig": { "deprecated": true, "$ref": "GoogleCloudAiplatformV1beta1ImageConfig", "description": "Optional. Config for image generation features. Deprecated: Use `response_format.image` instead." }, "speechConfig": { "$ref": "GoogleCloudAiplatformV1beta1SpeechConfig", "description": "Optional. The speech generation config." }, "presencePenalty": { "type": "number", "description": "Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].", "format": "float" }, "responseSchema": { "deprecated": true, "$ref": "GoogleCloudAiplatformV1beta1Schema", "description": "Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. Deprecated: Use `response_format` instead." }, "enableAffectiveDialog": { "description": "Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.", "type": "boolean" }, "responseJsonSchema": { "type": "any", "deprecated": true, "description": "Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. Deprecated: Use `response_format` instead." } }, "description": "Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output.", "id": "GoogleCloudAiplatformV1beta1GenerationConfig" }, "GoogleCloudAiplatformV1beta1SchemaTimeSegment": { "description": "A time period inside of a DataItem that has a time dimension (e.g. video).", "type": "object", "properties": { "startTimeOffset": { "format": "google-duration", "description": "Start of the time segment (inclusive), represented as the duration since the start of the DataItem.", "type": "string" }, "endTimeOffset": { "description": "End of the time segment (exclusive), represented as the duration since the start of the DataItem.", "format": "google-duration", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1SchemaTimeSegment" }, "GoogleCloudAiplatformV1beta1ModelMonitoringTabularStats": { "properties": { "statsName": { "type": "string", "description": "The stats name." }, "objectiveType": { "type": "string", "description": "One of the supported monitoring objectives: `raw-feature-drift` `prediction-output-drift` `feature-attribution`" }, "dataPoints": { "items": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringStatsDataPoint" }, "type": "array", "description": "The data points of this time series. When listing time series, points are returned in reverse time order." } }, "type": "object", "description": "A collection of data points that describes the time-varying values of a tabular metric.", "id": "GoogleCloudAiplatformV1beta1ModelMonitoringTabularStats" }, "GenaiVertexV1beta1GoogleMapsResultStep": { "description": "Google Maps result step.", "type": "object", "properties": { "result": { "items": { "$ref": "GenaiVertexV1beta1GoogleMapsResultStepGoogleMapsResultItem" }, "type": "array" } }, "id": "GenaiVertexV1beta1GoogleMapsResultStep" }, "GoogleCloudAiplatformV1beta1DeploymentResourcePool": { "properties": { "name": { "description": "Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", "type": "string" }, "createTime": { "description": "Output only. Timestamp when this DeploymentResourcePool was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "dedicatedResources": { "description": "Required. The underlying DedicatedResources that the DeploymentResourcePool uses.", "$ref": "GoogleCloudAiplatformV1beta1DedicatedResources" }, "encryptionSpec": { "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec", "description": "Customer-managed encryption key spec for a DeploymentResourcePool. If set, this DeploymentResourcePool will be secured by this key. Endpoints and the DeploymentResourcePool they deploy in need to have the same EncryptionSpec." }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "type": "boolean", "readOnly": true }, "disableContainerLogging": { "type": "boolean", "description": "If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true." }, "satisfiesPzs": { "readOnly": true, "description": "Output only. Reserved for future use.", "type": "boolean" }, "serviceAccount": { "type": "string", "description": "The service account that the DeploymentResourcePool's container(s) run as. Specify the email address of the service account. If this service account is not specified, the container(s) run as a service account that doesn't have access to the resource project. Users deploying the Models to this DeploymentResourcePool must have the `iam.serviceAccounts.actAs` permission on this service account." } }, "type": "object", "description": "A description of resources that can be shared by multiple DeployedModels, whose underlying specification consists of a DedicatedResources.", "id": "GoogleCloudAiplatformV1beta1DeploymentResourcePool" }, "GoogleCloudAiplatformV1beta1UpdatePersistentResourceOperationMetadata": { "type": "object", "id": "GoogleCloudAiplatformV1beta1UpdatePersistentResourceOperationMetadata", "description": "Details of operations that perform update PersistentResource.", "properties": { "genericMetadata": { "description": "Operation metadata for PersistentResource.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" }, "progressMessage": { "description": "Progress Message for Update LRO", "type": "string" } } }, "GoogleCloudAiplatformV1beta1AddContextArtifactsAndExecutionsResponse": { "type": "object", "properties": {}, "description": "Response message for MetadataService.AddContextArtifactsAndExecutions.", "id": "GoogleCloudAiplatformV1beta1AddContextArtifactsAndExecutionsResponse" }, "GoogleCloudAiplatformV1beta1ImportIndexRequestConnectorConfigDatapointFieldMappingNumericRestrict": { "description": "Restrictions on numeric values.", "id": "GoogleCloudAiplatformV1beta1ImportIndexRequestConnectorConfigDatapointFieldMappingNumericRestrict", "properties": { "namespace": { "type": "string", "description": "Required. The namespace of the restrict." }, "valueColumn": { "description": "Optional. The column containing the numeric value.", "type": "string" }, "valueType": { "description": "Required. Numeric type of the restrict. Must be consistent for all datapoints within the namespace.", "enum": [ "VALUE_TYPE_UNSPECIFIED", "INT", "FLOAT", "DOUBLE" ], "enumDescriptions": [ "Should not be used.", "Represents 64 bit integer.", "Represents 32 bit float.", "Represents 64 bit float." ], "type": "string" } }, "type": "object" }, "GenaiVertexV1beta1McpServerToolCallStep": { "id": "GenaiVertexV1beta1McpServerToolCallStep", "description": "MCPServer tool call step.", "properties": { "arguments": { "description": "Required. The JSON object of arguments for the function.", "$ref": "GenaiVertexV1beta1Struct" }, "serverName": { "description": "Required. The name of the used MCP server.", "type": "string" }, "name": { "type": "string", "description": "Required. The name of the tool which was called." } }, "type": "object" }, "GenaiVertexV1beta1AllowedTools": { "properties": { "tools": { "description": "The names of the allowed tools.", "type": "array", "items": { "type": "string" } }, "mode": { "enum": [ "TOOL_CHOICE_TYPE_UNSPECIFIED", "AUTO", "ANY", "NONE", "VALIDATED" ], "enumDescriptions": [ "Default value. This value is unused.", "Auto tool choice.", "Any tool choice.", "No tool choice.", "Validated tool choice." ], "description": "The mode of the tool choice.", "type": "string" } }, "type": "object", "id": "GenaiVertexV1beta1AllowedTools", "description": "The configuration for allowed tools." }, "GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualityInput": { "properties": { "metricSpec": { "$ref": "GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualitySpec", "description": "Required. Spec for pairwise question answering quality score metric." }, "instance": { "description": "Required. Pairwise question answering quality instance.", "$ref": "GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualityInstance" } }, "id": "GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualityInput", "description": "Input for pairwise question answering quality metric.", "type": "object" }, "GoogleCloudAiplatformV1beta1ListPersistentResourcesResponse": { "type": "object", "properties": { "persistentResources": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1PersistentResource" } }, "nextPageToken": { "type": "string", "description": "A token to retrieve next page of results. Pass to ListPersistentResourcesRequest.page_token to obtain that page." } }, "id": "GoogleCloudAiplatformV1beta1ListPersistentResourcesResponse", "description": "Response message for PersistentResourceService.ListPersistentResources" }, "GoogleCloudAiplatformV1beta1FeatureMonitorJobJobSummary": { "id": "GoogleCloudAiplatformV1beta1FeatureMonitorJobJobSummary", "type": "object", "properties": { "totalSlotMs": { "type": "string", "format": "int64", "description": "Output only. BigQuery slot milliseconds consumed.", "readOnly": true }, "featureStatsAndAnomalies": { "readOnly": true, "items": { "$ref": "GoogleCloudAiplatformV1beta1FeatureStatsAndAnomaly" }, "type": "array", "description": "Output only. Features and their stats and anomalies" } }, "description": "Summary from the FeatureMonitorJob." }, "GoogleCloudAiplatformV1beta1DistillationHyperParameters": { "description": "Hyperparameters for Distillation.", "properties": { "epochCount": { "format": "int64", "type": "string", "description": "Optional. Number of complete passes the model makes over the entire training dataset during training." }, "adapterSize": { "enum": [ "ADAPTER_SIZE_UNSPECIFIED", "ADAPTER_SIZE_ONE", "ADAPTER_SIZE_TWO", "ADAPTER_SIZE_FOUR", "ADAPTER_SIZE_EIGHT", "ADAPTER_SIZE_SIXTEEN", "ADAPTER_SIZE_THIRTY_TWO" ], "type": "string", "enumDescriptions": [ "Adapter size is unspecified.", "Adapter size 1.", "Adapter size 2.", "Adapter size 4.", "Adapter size 8.", "Adapter size 16.", "Adapter size 32." ], "description": "Optional. Adapter size for distillation." }, "learningRate": { "format": "double", "type": "number", "description": "Optional. Specifies the learning rate for tuning. Mutually exclusive with `learning_rate_multiplier`. This feature is only available for open source models." }, "learningRateMultiplier": { "format": "double", "description": "Optional. Multiplier for adjusting the default learning rate.", "type": "number" }, "batchSize": { "type": "string", "format": "int64", "description": "Optional. Batch size for tuning. This feature is only available for open source models." } }, "id": "GoogleCloudAiplatformV1beta1DistillationHyperParameters", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics": { "description": "Metrics for a single confidence threshold.", "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsTrackMetricsConfidenceMetrics", "properties": { "trackingPrecision": { "description": "Tracking precision.", "format": "float", "type": "number" }, "mismatchRate": { "format": "float", "description": "Mismatch rate, which measures the tracking consistency, i.e. correctness of instance ID continuity.", "type": "number" }, "boundingBoxIou": { "description": "Bounding box intersection-over-union precision. Measures how well the bounding boxes overlap between each other (e.g. complete overlap or just barely above iou_threshold).", "format": "float", "type": "number" }, "trackingRecall": { "description": "Tracking recall.", "type": "number", "format": "float" }, "confidenceThreshold": { "type": "number", "format": "float", "description": "The confidence threshold value used to compute the metrics." } } }, "GenaiVertexV1beta1GoogleSearchCallContent": { "type": "object", "properties": { "searchType": { "enum": [ "SEARCH_TYPE_UNSPECIFIED", "SEARCH_TYPE_WEB_SEARCH", "SEARCH_TYPE_IMAGE_SEARCH", "SEARCH_TYPE_ENTERPRISE_WEB_SEARCH" ], "type": "string", "description": "The type of search grounding enabled.", "enumDescriptions": [ "Unspecified search type. This value should not be used.", "Setting this field enables web search. Only text results are returned.", "Setting this field enables image search. Image bytes are returned.", "Setting this field enables enterprise web search." ] }, "arguments": { "description": "Required. The arguments to pass to Google Search.", "$ref": "GenaiVertexV1beta1GoogleSearchCallContentGoogleSearchCallArguments" } }, "deprecated": true, "id": "GenaiVertexV1beta1GoogleSearchCallContent", "description": "Google Search content." }, "GoogleCloudAiplatformV1beta1ModelMonitoringAlert": { "properties": { "anomaly": { "description": "Anomaly details.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringAnomaly" }, "statsName": { "description": "The stats name.", "type": "string" }, "alertTime": { "description": "Alert creation time.", "type": "string", "format": "google-datetime" }, "objectiveType": { "description": "One of the supported monitoring objectives: `raw-feature-drift` `prediction-output-drift` `feature-attribution`", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1ModelMonitoringAlert", "type": "object", "description": "Represents a single monitoring alert. This is currently used in the SearchModelMonitoringAlerts api, thus the alert wrapped in this message belongs to the resource asked in the request." }, "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestCloudTraceSource": { "id": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestCloudTraceSource", "type": "object", "properties": { "sessionIds": { "type": "array", "items": { "type": "string" }, "description": "Optional. Session IDs to import traces for. If both trace_ids and session_ids are specified, the union of the two will be imported." }, "traceIds": { "description": "Optional. Trace IDs to import.", "items": { "type": "string" }, "type": "array" }, "projectId": { "description": "Required. Project ID for the Cloud Trace.", "type": "string" } }, "description": "Source for loading traces directly from Cloud Trace." }, "GoogleCloudAiplatformV1beta1MemoryMetadataValue": { "type": "object", "properties": { "boolValue": { "description": "Represents a boolean value.", "type": "boolean" }, "stringValue": { "description": "Represents a string value.", "type": "string" }, "doubleValue": { "format": "double", "description": "Represents a double value.", "type": "number" }, "timestampValue": { "description": "Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.", "type": "string", "format": "google-datetime" } }, "description": "Memory metadata.", "id": "GoogleCloudAiplatformV1beta1MemoryMetadataValue" }, "GoogleCloudAiplatformV1beta1LogprobsResult": { "id": "GoogleCloudAiplatformV1beta1LogprobsResult", "properties": { "chosenCandidates": { "items": { "$ref": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate" }, "type": "array", "description": "A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`." }, "topCandidates": { "type": "array", "description": "A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps.", "items": { "$ref": "GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates" } } }, "type": "object", "description": "The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is \"hallucinating\" or generating factually incorrect information." }, "GoogleCloudAiplatformV1beta1ToolNameMatchInput": { "type": "object", "properties": { "instances": { "items": { "$ref": "GoogleCloudAiplatformV1beta1ToolNameMatchInstance" }, "description": "Required. Repeated tool name match instances.", "type": "array" }, "metricSpec": { "description": "Required. Spec for tool name match metric.", "$ref": "GoogleCloudAiplatformV1beta1ToolNameMatchSpec" } }, "description": "Input for tool name match metric.", "id": "GoogleCloudAiplatformV1beta1ToolNameMatchInput" }, "GenaiVertexV1beta1UrlContextResultDelta": { "type": "object", "properties": { "result": { "items": { "$ref": "GenaiVertexV1beta1UrlContextResultContentUrlContextResult" }, "type": "array" }, "isError": { "type": "boolean" } }, "id": "GenaiVertexV1beta1UrlContextResultDelta" }, "GoogleCloudAiplatformV1beta1ImportIndexRequestConnectorConfig": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ImportIndexRequestConnectorConfig", "properties": { "bigQuerySourceConfig": { "$ref": "GoogleCloudAiplatformV1beta1ImportIndexRequestConnectorConfigBigQuerySourceConfig", "description": "Configuration for importing data from a BigQuery table." } }, "description": "Configuration for importing data from an external source." }, "GoogleCloudAiplatformV1beta1UndeployModelOperationMetadata": { "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "The operation generic information." } }, "type": "object", "description": "Runtime operation information for EndpointService.UndeployModel.", "id": "GoogleCloudAiplatformV1beta1UndeployModelOperationMetadata" }, "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig": { "properties": { "targetNetwork": { "description": "Required. The VPC network name in the target_project where the DNS zone specified by `domain` is visible.", "type": "string" }, "domain": { "type": "string", "description": "Required. The DNS name suffix of the zone being peered to, e.g., \"my-internal-domain.corp.\". Must end with a dot." }, "targetProject": { "description": "Required. The project ID hosting the Cloud DNS managed zone that contains the `domain`. The Vertex AI Service Agent requires the dns.peer role on this project.", "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig", "description": "Configuration for peering a customer's private DNS zone so that sandbox egress can resolve customer-internal domains via the customer VPC." }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextClassification": { "properties": { "inputs": { "description": "The input parameters of this TrainingJob.", "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextClassificationInputs" } }, "description": "A TrainingJob that trains and uploads an AutoML Text Classification Model.", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTextClassification", "type": "object" }, "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigMemoryTopic": { "description": "A topic of information that should be extracted from conversations and stored as memories.", "properties": { "customMemoryTopic": { "$ref": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigMemoryTopicCustomMemoryTopic", "description": "A custom memory topic defined by the developer." }, "managedMemoryTopic": { "$ref": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigMemoryTopicManagedMemoryTopic", "description": "A managed memory topic defined by Memory Bank." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigMemoryTopic" }, "GoogleCloudAiplatformV1beta1FeaturestoreMonitoringConfig": { "type": "object", "id": "GoogleCloudAiplatformV1beta1FeaturestoreMonitoringConfig", "description": "Configuration of how features in Featurestore are monitored.", "properties": { "numericalThresholdConfig": { "description": "Threshold for numerical features of anomaly detection. This is shared by all objectives of Featurestore Monitoring for numerical features (i.e. Features with type (Feature.ValueType) DOUBLE or INT64).", "$ref": "GoogleCloudAiplatformV1beta1FeaturestoreMonitoringConfigThresholdConfig" }, "categoricalThresholdConfig": { "$ref": "GoogleCloudAiplatformV1beta1FeaturestoreMonitoringConfigThresholdConfig", "description": "Threshold for categorical features of anomaly detection. This is shared by all types of Featurestore Monitoring for categorical features (i.e. Features with type (Feature.ValueType) BOOL or STRING)." }, "importFeaturesAnalysis": { "description": "The config for ImportFeatures Analysis Based Feature Monitoring.", "$ref": "GoogleCloudAiplatformV1beta1FeaturestoreMonitoringConfigImportFeaturesAnalysis" }, "snapshotAnalysis": { "$ref": "GoogleCloudAiplatformV1beta1FeaturestoreMonitoringConfigSnapshotAnalysis", "description": "The config for Snapshot Analysis Based Feature Monitoring." } } }, "GoogleCloudAiplatformV1beta1SandboxEnvironmentSpecCodeExecutionEnvironment": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentSpecCodeExecutionEnvironment", "properties": { "machineConfig": { "enumDescriptions": [ "The default value: milligcu 2000, memory 1.5Gib", "The default value: milligcu 4000, memory 4 Gib" ], "enum": [ "MACHINE_CONFIG_UNSPECIFIED", "MACHINE_CONFIG_VCPU4_RAM4GIB" ], "description": "The machine config of the code execution environment.", "type": "string" }, "codeLanguage": { "enumDescriptions": [ "The default value. This value is unused.", "The coding language is Python.", "The coding language is JavaScript." ], "description": "The coding language supported in this environment.", "type": "string", "enum": [ "LANGUAGE_UNSPECIFIED", "LANGUAGE_PYTHON", "LANGUAGE_JAVASCRIPT" ] } }, "description": "The code execution environment with customized settings." }, "GoogleCloudAiplatformV1beta1ManualBatchTuningParameters": { "id": "GoogleCloudAiplatformV1beta1ManualBatchTuningParameters", "type": "object", "properties": { "batchSize": { "description": "Immutable. The number of the records (e.g. instances) of the operation given in each batch to a machine replica. Machine type, and size of a single record should be considered when setting this parameter, higher value speeds up the batch operation's execution, but too high value will result in a whole batch not fitting in a machine's memory, and the whole operation will fail. The default value is 64.", "type": "integer", "format": "int32" } }, "description": "Manual batch tuning parameters." }, "GoogleCloudAiplatformV1beta1HyperparameterTuningJob": { "id": "GoogleCloudAiplatformV1beta1HyperparameterTuningJob", "type": "object", "description": "Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification.", "properties": { "satisfiesPzs": { "readOnly": true, "description": "Output only. Reserved for future use.", "type": "boolean" }, "labels": { "additionalProperties": { "type": "string" }, "description": "The labels with user-defined metadata to organize HyperparameterTuningJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.", "type": "object" }, "name": { "type": "string", "readOnly": true, "description": "Output only. Resource name of the HyperparameterTuningJob." }, "parallelTrialCount": { "type": "integer", "format": "int32", "description": "Required. The desired number of Trials to run in parallel." }, "error": { "readOnly": true, "$ref": "GoogleRpcStatus", "description": "Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED." }, "maxTrialCount": { "description": "Required. The desired total number of Trials.", "type": "integer", "format": "int32" }, "updateTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Time when the HyperparameterTuningJob was most recently updated.", "type": "string" }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "type": "boolean", "readOnly": true }, "encryptionSpec": { "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec", "description": "Customer-managed encryption key options for a HyperparameterTuningJob. If this is set, then all resources created by the HyperparameterTuningJob will be encrypted with the provided encryption key." }, "state": { "readOnly": true, "enum": [ "JOB_STATE_UNSPECIFIED", "JOB_STATE_QUEUED", "JOB_STATE_PENDING", "JOB_STATE_RUNNING", "JOB_STATE_SUCCEEDED", "JOB_STATE_FAILED", "JOB_STATE_CANCELLING", "JOB_STATE_CANCELLED", "JOB_STATE_PAUSED", "JOB_STATE_EXPIRED", "JOB_STATE_UPDATING", "JOB_STATE_PARTIALLY_SUCCEEDED" ], "description": "Output only. The detailed state of the job.", "type": "string", "enumDescriptions": [ "The job state is unspecified.", "The job has been just created or resumed and processing has not yet begun.", "The service is preparing to run the job.", "The job is in progress.", "The job completed successfully.", "The job failed.", "The job is being cancelled. From this state the job may only go to either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.", "The job has been cancelled.", "The job has been stopped, and can be resumed.", "The job has expired.", "The job is being updated. Only jobs in the `RUNNING` state can be updated. After updating, the job goes back to the `RUNNING` state.", "The job is partially succeeded, some results may be missing due to errors." ] }, "maxFailedTrialCount": { "type": "integer", "description": "The number of failed Trials that need to be seen before failing the HyperparameterTuningJob. If set to 0, Vertex AI decides how many Trials must fail before the whole job fails.", "format": "int32" }, "trialJobSpec": { "description": "Required. The spec of a trial job. The same spec applies to the CustomJobs created in all the trials.", "$ref": "GoogleCloudAiplatformV1beta1CustomJobSpec" }, "displayName": { "type": "string", "description": "Required. The display name of the HyperparameterTuningJob. The name can be up to 128 characters long and can consist of any UTF-8 characters." }, "studySpec": { "description": "Required. Study configuration of the HyperparameterTuningJob.", "$ref": "GoogleCloudAiplatformV1beta1StudySpec" }, "createTime": { "readOnly": true, "description": "Output only. Time when the HyperparameterTuningJob was created.", "type": "string", "format": "google-datetime" }, "startTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Time when the HyperparameterTuningJob for the first time entered the `JOB_STATE_RUNNING` state.", "type": "string" }, "endTime": { "description": "Output only. Time when the HyperparameterTuningJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.", "format": "google-datetime", "readOnly": true, "type": "string" }, "trials": { "description": "Output only. Trials of the HyperparameterTuningJob.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Trial" }, "type": "array", "readOnly": true } } }, "GoogleCloudAiplatformV1beta1GenerateMemoriesRequestDirectContentsSourceEvent": { "type": "object", "id": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequestDirectContentsSourceEvent", "properties": { "content": { "description": "Required. A single piece of content from which to generate memories.", "$ref": "GoogleCloudAiplatformV1beta1Content" } }, "description": "A single piece of conversation from which to generate memories." }, "GoogleCloudAiplatformV1beta1StoredContentsExampleParameters": { "id": "GoogleCloudAiplatformV1beta1StoredContentsExampleParameters", "properties": { "functionNames": { "description": "Optional. The function names for filtering.", "$ref": "GoogleCloudAiplatformV1beta1ExamplesArrayFilter" }, "searchKey": { "type": "string", "description": "The exact search key to use for retrieval." }, "contentSearchKey": { "$ref": "GoogleCloudAiplatformV1beta1StoredContentsExampleParametersContentSearchKey", "description": "The chat history to use to generate the search key for retrieval." } }, "type": "object", "description": "The metadata filters that will be used to search StoredContentsExamples. If a field is unspecified, then no filtering for that field will be applied" }, "GoogleCloudAiplatformV1beta1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition": { "description": "Represents the spec to match categorical values from parent parameter.", "id": "GoogleCloudAiplatformV1beta1StudySpecParameterSpecConditionalParameterSpecCategoricalValueCondition", "properties": { "values": { "items": { "type": "string" }, "type": "array", "description": "Required. Matches values of the parent parameter of 'CATEGORICAL' type. All values must exist in `categorical_value_spec` of parent parameter." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ListSavedQueriesResponse": { "id": "GoogleCloudAiplatformV1beta1ListSavedQueriesResponse", "description": "Response message for DatasetService.ListSavedQueries.", "properties": { "savedQueries": { "description": "A list of SavedQueries that match the specified filter in the request.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1SavedQuery" } }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." } }, "type": "object" }, "CloudAiLargeModelsVisionGenerateVideoRequestImage": { "id": "CloudAiLargeModelsVisionGenerateVideoRequestImage", "properties": { "gcsUri": { "type": "string" }, "bytesBase64Encoded": { "type": "string", "description": "Base64 encoded bytes string representing the image." }, "mimeType": { "type": "string", "description": "The MIME type of the content of the image. Only the images in below listed MIME types are supported. - image/jpeg - image/png" }, "blobId": { "type": "string", "description": "Blob ID of the image. This is used for storing the large images in the request." } }, "type": "object", "description": "The image bytes or Cloud Storage URI to make the prediction on." }, "GoogleCloudAiplatformV1beta1Claim": { "type": "object", "description": "Claim that is extracted from the input text and facts that support it.", "id": "GoogleCloudAiplatformV1beta1Claim", "properties": { "endIndex": { "type": "integer", "format": "int32", "description": "Index in the input text where the claim ends (exclusive)." }, "score": { "description": "Confidence score of this corroboration.", "type": "number", "format": "float" }, "startIndex": { "format": "int32", "description": "Index in the input text where the claim starts (inclusive).", "type": "integer" }, "factIndexes": { "description": "Indexes of the facts supporting this claim.", "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "GoogleCloudAiplatformV1beta1ActivateOnlineEvaluatorOperationMetadata": { "description": "Metadata for the ActivateOnlineEvaluator operation.", "properties": { "genericMetadata": { "description": "Common part of operation metadata.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ActivateOnlineEvaluatorOperationMetadata" }, "GoogleCloudAiplatformV1beta1UserSpecifiedMetadata": { "type": "object", "id": "GoogleCloudAiplatformV1beta1UserSpecifiedMetadata", "properties": { "value": { "$ref": "GoogleCloudAiplatformV1beta1MetadataValue", "description": "Value of the metadata. The value must be able to convert to the type according to the data schema." }, "key": { "type": "string", "description": "Required. Key of the metadata. The key must be set with type by CreateRagDataSchema." } }, "description": "Metadata provided by users." }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation": { "description": "Treats the column as numerical array and performs following transformation functions. * All transformations for Numerical types applied to the average of the all elements. * The average of empty arrays is treated as zero.", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation", "properties": { "invalidValuesAllowed": { "description": "If invalid values is allowed, the training pipeline will create a boolean feature that indicated whether the value is valid. Otherwise, the training pipeline will discard the input row from trainining data.", "type": "boolean" }, "columnName": { "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ExampleStore": { "type": "object", "description": "Represents an executable service to manage and retrieve examples.", "properties": { "name": { "type": "string", "description": "Identifier. The resource name of the ExampleStore. This is a unique identifier. Format: projects/{project}/locations/{location}/exampleStores/{example_store}" }, "displayName": { "type": "string", "description": "Required. Display name of the ExampleStore." }, "updateTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. Timestamp when this ExampleStore was most recently updated." }, "description": { "type": "string", "description": "Optional. Description of the ExampleStore." }, "createTime": { "type": "string", "description": "Output only. Timestamp when this ExampleStore was created.", "format": "google-datetime", "readOnly": true }, "exampleStoreConfig": { "description": "Required. Example Store config.", "$ref": "GoogleCloudAiplatformV1beta1ExampleStoreConfig" } }, "id": "GoogleCloudAiplatformV1beta1ExampleStore" }, "GoogleCloudAiplatformV1beta1RetrieveMemoriesResponseRetrievedMemory": { "description": "A retrieved memory.", "properties": { "memory": { "$ref": "GoogleCloudAiplatformV1beta1Memory", "description": "The retrieved Memory." }, "distance": { "format": "double", "description": "The distance between the query and the retrieved Memory. Smaller values indicate more similar memories. This is only set if similarity search was used for retrieval.", "type": "number" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1RetrieveMemoriesResponseRetrievedMemory" }, "GoogleTypeLatLng": { "id": "GoogleTypeLatLng", "type": "object", "description": "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.", "properties": { "latitude": { "format": "double", "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", "type": "number" }, "longitude": { "type": "number", "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", "format": "double" } } }, "GoogleCloudAiplatformV1beta1ListA2aTasksResponse": { "description": "Response message for ListA2aTasks.", "properties": { "a2aTasks": { "items": { "$ref": "GoogleCloudAiplatformV1beta1A2aTask" }, "type": "array", "description": "List of A2aTasks in the requested page." }, "nextPageToken": { "description": "A token, which can be sent as ListA2aTasksRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ListA2aTasksResponse" }, "GoogleCloudAiplatformV1beta1SpeculativeDecodingSpec": { "description": "Configuration for Speculative Decoding.", "properties": { "draftModelSpeculation": { "description": "draft model speculation.", "$ref": "GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecDraftModelSpeculation" }, "ngramSpeculation": { "description": "N-Gram speculation.", "$ref": "GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecNgramSpeculation" }, "speculativeTokenCount": { "type": "integer", "description": "The number of speculative tokens to generate at each step.", "format": "int32" } }, "id": "GoogleCloudAiplatformV1beta1SpeculativeDecodingSpec", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaPredictParamsVideoClassificationPredictionParams": { "description": "Prediction model parameters for Video Classification.", "properties": { "segmentClassification": { "description": "Set to true to request segment-level classification. Vertex AI returns labels and their confidence scores for the entire time segment of the video that user specified in the input instance. Default value is true", "type": "boolean" }, "confidenceThreshold": { "description": "The Model only returns predictions with at least this confidence score. Default value is 0.0", "format": "float", "type": "number" }, "oneSecIntervalClassification": { "type": "boolean", "description": "Set to true to request classification for a video at one-second intervals. Vertex AI returns labels and their confidence scores for each second of the entire time segment of the video that user specified in the input WARNING: Model evaluation is not done for this classification type, the quality of it depends on the training data, but there are no metrics provided to describe that quality. Default value is false" }, "maxPredictions": { "description": "The Model only returns up to that many top, by confidence score, predictions per instance. If this number is very high, the Model may return fewer predictions. Default value is 10,000.", "format": "int32", "type": "integer" }, "shotClassification": { "type": "boolean", "description": "Set to true to request shot-level classification. Vertex AI determines the boundaries for each camera shot in the entire time segment of the video that user specified in the input instance. Vertex AI then returns labels and their confidence scores for each detected shot, along with the start and end time of the shot. WARNING: Model evaluation is not done for this classification type, the quality of it depends on the training data, but there are no metrics provided to describe that quality. Default value is false" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaPredictParamsVideoClassificationPredictionParams" }, "GoogleCloudAiplatformV1beta1ImageConfigImageOutputOptions": { "description": "The image output format for generated images.", "id": "GoogleCloudAiplatformV1beta1ImageConfigImageOutputOptions", "properties": { "mimeType": { "type": "string", "description": "Optional. The image format that the output should be saved as." }, "compressionQuality": { "format": "int32", "description": "Optional. The compression quality of the output image.", "type": "integer" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingInputsTransformationTimestampTransformation", "description": "Training pipeline will perform following transformation functions. * Apply the transformation functions for Numerical columns. * Determine the year, month, day,and weekday. Treat each value from the timestamp as a Categorical column. * Invalid numerical values (for example, values that fall outside of a typical timestamp range, or are extreme values) receive no special treatment and are not removed.", "properties": { "columnName": { "type": "string" }, "timeFormat": { "description": "The format in which that time field is expressed. The time_format must either be one of: * `unix-seconds` * `unix-milliseconds` * `unix-microseconds` * `unix-nanoseconds` (for respectively number of seconds, milliseconds, microseconds and nanoseconds since start of the Unix epoch); or be written in `strftime` syntax. If time_format is not set, then the default format is RFC 3339 `date-time` format, where `time-offset` = `\"Z\"` (e.g. 1985-04-12T23:20:50.52Z)", "type": "string" } } }, "GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexFeatureStore": { "properties": { "featureViewResourceName": { "description": "The resource name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", "type": "string" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexFeatureStore", "description": "The config for the Vertex Feature Store." }, "GoogleCloudAiplatformV1beta1ListMemoriesResponse": { "description": "Response message for MemoryBankService.ListMemories.", "type": "object", "id": "GoogleCloudAiplatformV1beta1ListMemoriesResponse", "properties": { "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results. Pass to ListMemoriesRequest.page_token to obtain that page." }, "memories": { "description": "List of Memories in the requested page.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Memory" } } } }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTables": { "description": "A TrainingJob that trains and uploads an AutoML Tables Model.", "type": "object", "properties": { "inputs": { "description": "The input parameters of this TrainingJob.", "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputs" }, "metadata": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesMetadata", "description": "The metadata information." } }, "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTables" }, "GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponse": { "properties": { "nextPageToken": { "description": "A token to retrieve the next page of results.", "type": "string" }, "summary": { "description": "Summary statistics computed across the sessions on the current page only. For statistics across the entire result set, use AggregateAnalyzedSessions.", "$ref": "GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary" }, "analyzedSessions": { "items": { "$ref": "GoogleCloudAiplatformV1beta1AnalyzedSession" }, "description": "The list of analyzed sessions.", "type": "array" } }, "description": "Response to list analyzed sessions.", "id": "GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponse", "type": "object" }, "GoogleCloudAiplatformV1beta1NotebookExecutionJobGcsNotebookSource": { "id": "GoogleCloudAiplatformV1beta1NotebookExecutionJobGcsNotebookSource", "properties": { "uri": { "description": "The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`", "type": "string" }, "generation": { "description": "The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.", "type": "string" } }, "description": "The Cloud Storage uri for the input notebook.", "type": "object" }, "GoogleCloudAiplatformV1beta1ExportModelRequest": { "properties": { "outputConfig": { "description": "Required. The desired output location and configuration.", "$ref": "GoogleCloudAiplatformV1beta1ExportModelRequestOutputConfig" } }, "type": "object", "description": "Request message for ModelService.ExportModel.", "id": "GoogleCloudAiplatformV1beta1ExportModelRequest" }, "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentDataEvents": { "type": "object", "properties": { "event": { "description": "Optional. A list of events.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" }, "type": "array" } }, "id": "GoogleCloudAiplatformV1beta1EvaluationInstanceDeprecatedAgentDataEvents", "description": "Represents a list of events for an agent." }, "GoogleCloudAiplatformV1beta1UserScenario": { "description": "Output of user scenario generation.", "properties": { "testCaseTitle": { "description": "Represents a short 3-5 word title for eval test case.", "type": "string" }, "startingPrompt": { "description": "Starting prompt for the conversation between simulated user and agent under the test.", "type": "string" }, "conversationPlan": { "type": "string", "description": "Conversation plan to drive multi-turn agent run and get simulated agent eval dataset." } }, "id": "GoogleCloudAiplatformV1beta1UserScenario", "type": "object" }, "GoogleCloudAiplatformV1beta1WriteFeatureValuesRequest": { "description": "Request message for FeaturestoreOnlineServingService.WriteFeatureValues.", "type": "object", "properties": { "payloads": { "type": "array", "description": "Required. The entities to be written. Up to 100,000 feature values can be written across all `payloads`.", "items": { "$ref": "GoogleCloudAiplatformV1beta1WriteFeatureValuesPayload" } } }, "id": "GoogleCloudAiplatformV1beta1WriteFeatureValuesRequest" }, "GoogleCloudAiplatformV1beta1GenerateContentResponse": { "id": "GoogleCloudAiplatformV1beta1GenerateContentResponse", "description": "Response message for [PredictionService.GenerateContent].", "type": "object", "properties": { "responseId": { "description": "Output only. response_id is used to identify each response. It is the encoding of the event_id.", "type": "string", "readOnly": true }, "modelVersion": { "readOnly": true, "description": "Output only. The model version used to generate the response.", "type": "string" }, "usageMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata", "description": "Usage metadata about the response(s)." }, "promptFeedback": { "description": "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.", "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponsePromptFeedback" }, "createTime": { "readOnly": true, "description": "Output only. Timestamp when the request is made to the server.", "format": "google-datetime", "type": "string" }, "candidates": { "readOnly": true, "description": "Output only. Generated candidates.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Candidate" } } } }, "GoogleCloudAiplatformV1beta1NotebookReservationAffinity": { "properties": { "key": { "type": "string", "description": "Optional. Corresponds to the label key of a reservation resource. To target a RESERVATION_SPECIFIC by name, use compute.googleapis.com/reservation-name as the key and specify the name of your reservation as its value." }, "values": { "type": "array", "items": { "type": "string" }, "description": "Optional. Corresponds to the label values of a reservation resource. This must be the full path name of Reservation." }, "consumeReservationType": { "description": "Required. Specifies the type of reservation from which this instance can consume resources: RESERVATION_ANY (default), RESERVATION_SPECIFIC, or RESERVATION_NONE. See Consuming reserved instances for examples.", "enumDescriptions": [ "Default type.", "Do not consume from any allocated capacity.", "Consume any reservation available.", "Must consume from a specific reservation. Must specify key value fields for specifying the reservations." ], "type": "string", "enum": [ "RESERVATION_AFFINITY_TYPE_UNSPECIFIED", "RESERVATION_NONE", "RESERVATION_ANY", "RESERVATION_SPECIFIC" ] } }, "id": "GoogleCloudAiplatformV1beta1NotebookReservationAffinity", "type": "object", "description": "Notebook Reservation Affinity for consuming Zonal reservation." }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingInputsGranularity": { "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionTftForecastingInputsGranularity", "properties": { "unit": { "description": "The time granularity unit of this time period. The supported units are: * \"minute\" * \"hour\" * \"day\" * \"week\" * \"month\" * \"year\"", "type": "string" }, "quantity": { "type": "string", "description": "The number of granularity_units between data points in the training data. If `granularity_unit` is `minute`, can be 1, 5, 10, 15, or 30. For all other values of `granularity_unit`, must be 1.", "format": "int64" } }, "description": "A duration of time expressed in time granularity units." }, "GoogleTypeInterval": { "type": "object", "id": "GoogleTypeInterval", "properties": { "endTime": { "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", "type": "string", "format": "google-datetime" }, "startTime": { "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", "format": "google-datetime", "type": "string" } }, "description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time." }, "GoogleCloudAiplatformV1beta1ExportDataResponse": { "id": "GoogleCloudAiplatformV1beta1ExportDataResponse", "type": "object", "description": "Response message for DatasetService.ExportData.", "properties": { "exportedFiles": { "type": "array", "items": { "type": "string" }, "description": "All of the files that are exported in this export operation. For custom code training export, only three (training, validation and test) Cloud Storage paths in wildcard format are populated (for example, gs://.../training-*)." } } }, "GoogleCloudAiplatformV1beta1AgentResponseCustomization": { "description": "Customizes the agent's response to the end user when a `SemanticGovernancePolicy` is evaluated (for example, with a custom message shown on denial).", "properties": { "denialMessage": { "type": "string", "description": "Optional. Custom message shown to the end user when the policy check results in a denial. Use this to explain the rationale to the user. Max 1000 characters." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1AgentResponseCustomization" }, "GoogleCloudAiplatformV1beta1SchemaVideoActionRecognitionAnnotation": { "description": "Annotation details specific to video action recognition.", "type": "object", "properties": { "annotationSpecId": { "description": "The resource Id of the AnnotationSpec that this Annotation pertains to.", "type": "string" }, "timeSegment": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTimeSegment", "description": "This Annotation applies to the time period represented by the TimeSegment. If it's not set, the Annotation applies to the whole video." }, "displayName": { "description": "The display name of the AnnotationSpec that this Annotation pertains to.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1SchemaVideoActionRecognitionAnnotation" }, "GoogleIamV1Policy": { "id": "GoogleIamV1Policy", "type": "object", "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", "properties": { "bindings": { "type": "array", "items": { "$ref": "GoogleIamV1Binding" }, "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`." }, "etag": { "format": "byte", "type": "string", "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost." }, "version": { "format": "int32", "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer" } } }, "GoogleCloudAiplatformV1beta1BigQueryDestination": { "type": "object", "description": "The BigQuery location for the output content.", "id": "GoogleCloudAiplatformV1beta1BigQueryDestination", "properties": { "outputUri": { "type": "string", "description": "Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`." } } }, "GenaiVertexV1beta1ImageConfig": { "type": "object", "id": "GenaiVertexV1beta1ImageConfig", "properties": { "aspectRatio": { "type": "string", "description": "The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided." }, "imageSize": { "type": "string", "description": "Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`." } }, "description": "The configuration for image interaction." }, "GoogleProtobufEmpty": { "id": "GoogleProtobufEmpty", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "type": "object", "properties": {} }, "GoogleCloudAiplatformV1beta1Study": { "properties": { "displayName": { "description": "Required. Describes the Study, default value is empty string.", "type": "string" }, "studySpec": { "$ref": "GoogleCloudAiplatformV1beta1StudySpec", "description": "Required. Configuration of the Study." }, "name": { "type": "string", "description": "Output only. The name of a study. The study's globally unique identifier. Format: `projects/{project}/locations/{location}/studies/{study}`", "readOnly": true }, "state": { "enumDescriptions": [ "The study state is unspecified.", "The study is active.", "The study is stopped due to an internal error.", "The study is done when the service exhausts the parameter search space or max_trial_count is reached." ], "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "INACTIVE", "COMPLETED" ], "readOnly": true, "type": "string", "description": "Output only. The detailed state of a Study." }, "inactiveReason": { "readOnly": true, "description": "Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.", "type": "string" }, "createTime": { "type": "string", "description": "Output only. Time at which the study was created.", "readOnly": true, "format": "google-datetime" } }, "type": "object", "description": "A message representing a Study.", "id": "GoogleCloudAiplatformV1beta1Study" }, "GoogleCloudAiplatformV1beta1SchemaPredictInstanceImageSegmentationPredictionInstance": { "description": "Prediction input format for Image Segmentation.", "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaPredictInstanceImageSegmentationPredictionInstance", "properties": { "content": { "description": "The image bytes to make the predictions on.", "type": "string" }, "mimeType": { "type": "string", "description": "The MIME type of the content of the image. Only the images in below listed MIME types are supported. - image/jpeg - image/png" } } }, "GoogleCloudAiplatformV1beta1ListMemoryRevisionsResponse": { "id": "GoogleCloudAiplatformV1beta1ListMemoryRevisionsResponse", "description": "Response message for MemoryBankService.ListMemoryRevisions.", "type": "object", "properties": { "memoryRevisions": { "items": { "$ref": "GoogleCloudAiplatformV1beta1MemoryRevision" }, "type": "array", "description": "The list of Memory Revisions in the request page." }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } } }, "GoogleCloudAiplatformV1beta1FluencyInput": { "id": "GoogleCloudAiplatformV1beta1FluencyInput", "description": "Input for fluency metric.", "properties": { "instance": { "description": "Required. Fluency instance.", "$ref": "GoogleCloudAiplatformV1beta1FluencyInstance" }, "metricSpec": { "description": "Required. Spec for fluency score metric.", "$ref": "GoogleCloudAiplatformV1beta1FluencySpec" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1UpdateFeatureGroupOperationMetadata": { "properties": { "genericMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "Operation metadata for FeatureGroup." } }, "description": "Details of operations that perform update FeatureGroup.", "id": "GoogleCloudAiplatformV1beta1UpdateFeatureGroupOperationMetadata", "type": "object" }, "GoogleCloudAiplatformV1beta1EnableXmanagerOperationMetadata": { "description": "Metadata message for EnableXmanager RPC.", "properties": { "progress": { "type": "string", "readOnly": true, "description": "Output only. Progress Message for EnableXmanager LRO" }, "genericMetadata": { "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", "description": "Output only. Operation metadata for EnableXmanager." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1EnableXmanagerOperationMetadata" }, "GoogleCloudAiplatformV1beta1PreferenceOptimizationSpec": { "properties": { "hyperParameters": { "description": "Optional. Hyperparameters for Preference Optimization.", "$ref": "GoogleCloudAiplatformV1beta1PreferenceOptimizationHyperParameters" }, "trainingDatasetUri": { "type": "string", "description": "Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file." }, "validationDatasetUri": { "description": "Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.", "type": "string" }, "exportLastCheckpointOnly": { "type": "boolean", "description": "Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false." } }, "type": "object", "description": "Tuning Spec for Preference Optimization.", "id": "GoogleCloudAiplatformV1beta1PreferenceOptimizationSpec" }, "GoogleCloudAiplatformV1beta1PscAutomatedEndpoints": { "id": "GoogleCloudAiplatformV1beta1PscAutomatedEndpoints", "type": "object", "properties": { "network": { "description": "Corresponding network in pscAutomationConfigs.", "type": "string" }, "matchAddress": { "description": "Ip Address created by the automated forwarding rule.", "type": "string" }, "projectId": { "description": "Corresponding project_id in pscAutomationConfigs", "type": "string" } }, "description": "PscAutomatedEndpoints defines the output of the forwarding rule automatically created by each PscAutomationConfig." }, "GenaiVertexV1beta1FileSearchResultDelta": { "properties": { "result": { "items": { "$ref": "GenaiVertexV1beta1FileSearchResultContentFileSearchResult" }, "type": "array" } }, "type": "object", "id": "GenaiVertexV1beta1FileSearchResultDelta" }, "GoogleCloudAiplatformV1beta1GeminiExample": { "description": "Format for Gemini examples used for Vertex Multimodal datasets.", "type": "object", "id": "GoogleCloudAiplatformV1beta1GeminiExample", "properties": { "safetySettings": { "description": "Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1SafetySetting" } }, "modelArmorConfig": { "description": "Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.", "$ref": "GoogleCloudAiplatformV1beta1ModelArmorConfig" }, "toolConfig": { "$ref": "GoogleCloudAiplatformV1beta1ToolConfig", "description": "Optional. Tool config. This config is shared for all tools provided in the request." }, "cachedContent": { "type": "string", "description": "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}`" }, "generationConfig": { "description": "Optional. Generation config.", "$ref": "GoogleCloudAiplatformV1beta1GenerationConfig" }, "labels": { "type": "object", "description": "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.", "additionalProperties": { "type": "string" } }, "tools": { "items": { "$ref": "GoogleCloudAiplatformV1beta1Tool" }, "type": "array", "description": "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." }, "model": { "type": "string", "description": "Optional. 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}`" }, "contents": { "description": "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.", "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" } }, "systemInstruction": { "$ref": "GoogleCloudAiplatformV1beta1Content", "description": "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." } } }, "GoogleCloudAiplatformV1beta1ExportDataConfig": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ExportDataConfig", "properties": { "gcsDestination": { "$ref": "GoogleCloudAiplatformV1beta1GcsDestination", "description": "The Google Cloud Storage location where the output is to be written to. In the given directory a new directory will be created with name: `export-data--` where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. All export output will be written into that directory. Inside that directory, annotations with the same schema will be grouped into sub directories which are named with the corresponding annotations' schema title. Inside these sub directories, a schema.yaml will be created to describe the output format." }, "annotationsFilter": { "type": "string", "description": "An expression for filtering what part of the Dataset is to be exported. Only Annotations that match this filter will be exported. The filter syntax is the same as in ListAnnotations." }, "fractionSplit": { "$ref": "GoogleCloudAiplatformV1beta1ExportFractionSplit", "description": "Split based on fractions defining the size of each set." } }, "description": "Describes what part of the Dataset is to be exported, the destination of the export and how to export." }, "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplate": { "type": "object", "description": "The specification of a SandboxEnvironmentTemplate. A SandboxEnvironmentTemplate defines a template for creating SandboxEnvironments.", "properties": { "egressControlConfig": { "description": "Optional. The configuration for egress control of this template.", "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfig" }, "defaultContainerEnvironment": { "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateDefaultContainerEnvironment", "description": "The sandbox environment for default container workloads." }, "useGkeTd": { "type": "boolean", "description": "Optional. Immutable. Whether to provision the SandboxEnvironmentTemplate via the GKE TD pool." }, "name": { "description": "Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`", "type": "string" }, "ingressControlConfig": { "$ref": "GoogleCloudAiplatformV1beta1PrivateServiceConnectConfig", "description": "Optional. The configuration for private ingress (PSC-E) of this template. When set, the sandbox router is exposed privately via a PSC service attachment so VPC-SC customers can connect from their VPC over a private endpoint instead of the public internet. The resulting service attachment is surfaced on `SandboxEnvironment.connection_info.service_attachment`. Only the PSC-E (service-attachment/ingress) portion of `PrivateServiceConnectConfig` applies here: `enable_private_service_connect` and `project_allowlist` (the consumer projects allowed to connect). The nested `psc_interface_config` (PSC-I / egress) is not used for sandbox ingress; sandbox egress is configured via `egress_control_config` instead." }, "updateTime": { "description": "Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "displayName": { "description": "Required. The display name of the SandboxEnvironmentTemplate.", "type": "string" }, "state": { "enumDescriptions": [ "The default value. This value is unused.", "Runtime resources are being allocated for the sandbox environment.", "Sandbox runtime is ready for serving.", "Sandbox runtime is halted, performing tear down tasks.", "Sandbox has terminated with underlying runtime failure.", "Sandbox has failed to provision." ], "enum": [ "UNSPECIFIED", "PROVISIONING", "ACTIVE", "DEPROVISIONING", "DELETED", "FAILED" ], "type": "string", "readOnly": true, "description": "Output only. The state of the sandbox environment template." }, "customContainerEnvironment": { "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateCustomContainerEnvironment", "description": "The sandbox environment for custom container workloads." }, "createTime": { "description": "Output only. The timestamp when this SandboxEnvironmentTemplate was created.", "type": "string", "format": "google-datetime", "readOnly": true } }, "id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplate" }, "GoogleCloudAiplatformV1beta1RagFileParsingConfigAdvancedParser": { "type": "object", "description": "Specifies the advanced parsing for RagFiles.", "properties": { "useAdvancedPdfParsing": { "type": "boolean", "description": "Whether to use advanced PDF parsing." } }, "id": "GoogleCloudAiplatformV1beta1RagFileParsingConfigAdvancedParser" }, "GoogleCloudAiplatformV1beta1SchemaImageSegmentationAnnotationPolygonAnnotation": { "id": "GoogleCloudAiplatformV1beta1SchemaImageSegmentationAnnotationPolygonAnnotation", "type": "object", "properties": { "annotationSpecId": { "type": "string", "description": "The resource Id of the AnnotationSpec that this Annotation pertains to." }, "displayName": { "description": "The display name of the AnnotationSpec that this Annotation pertains to.", "type": "string" }, "vertexes": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaVertex" }, "description": "The vertexes are connected one by one and the last vertex is connected to the first one to represent a polygon." } }, "description": "Represents a polygon in image." }, "GoogleCloudAiplatformV1beta1ExampleStoreConfig": { "description": "Configuration for the Example Store.", "id": "GoogleCloudAiplatformV1beta1ExampleStoreConfig", "type": "object", "properties": { "vertexEmbeddingModel": { "type": "string", "description": "Required. The embedding model to be used for vector embedding. Immutable. Supported models: * \"text-embedding-005\" * \"text-multilingual-embedding-002\"" } } }, "GoogleCloudAiplatformV1beta1DeleteFeatureValuesResponse": { "id": "GoogleCloudAiplatformV1beta1DeleteFeatureValuesResponse", "description": "Response message for FeaturestoreService.DeleteFeatureValues.", "properties": { "selectEntity": { "$ref": "GoogleCloudAiplatformV1beta1DeleteFeatureValuesResponseSelectEntity", "description": "Response for request specifying the entities to delete" }, "selectTimeRangeAndFeature": { "description": "Response for request specifying time range and feature", "$ref": "GoogleCloudAiplatformV1beta1DeleteFeatureValuesResponseSelectTimeRangeAndFeature" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1CloudLoggingConfig": { "type": "object", "properties": { "tracingContext": { "description": "Optional. Tracing context for the evaluation run.", "$ref": "GoogleCloudAiplatformV1beta1CloudLoggingConfigTracingContext" }, "resourceLabels": { "type": "object", "description": "Optional. MonitoredResource labels to associate the log with. The backend will automatically inject project and location.", "additionalProperties": { "type": "string" } }, "resourceType": { "type": "string", "description": "Optional. MonitoredResource type. Defaults to \"global\" if unspecified." }, "project": { "type": "string", "description": "Optional. Google Cloud project to write logs to. Defaults to the request project." } }, "id": "GoogleCloudAiplatformV1beta1CloudLoggingConfig", "description": "Specifies configuration for exporting evaluation results to Cloud Logging." }, "GoogleCloudAiplatformV1beta1IngestionDirectContentsSource": { "properties": { "events": { "type": "array", "items": { "$ref": "GoogleCloudAiplatformV1beta1IngestionDirectContentsSourceEvent" }, "description": "Required. The events to ingest." } }, "description": "Ingest events directly from the request.", "type": "object", "id": "GoogleCloudAiplatformV1beta1IngestionDirectContentsSource" }, "GoogleCloudAiplatformV1beta1ClientConnectionConfig": { "type": "object", "properties": { "inferenceTimeout": { "type": "string", "description": "Customizable online prediction request timeout.", "format": "google-duration" } }, "description": "Configurations (e.g. inference timeout) that are applied on your endpoints.", "id": "GoogleCloudAiplatformV1beta1ClientConnectionConfig" }, "GoogleCloudAiplatformV1beta1SchemaVertex": { "description": "Represents a 2D point in the image. Vertex coordinates are normalized to be relative to the original image dimensions and range from 0 to 1. The origin of the coordinate system (0,0) is the top-left corner of the image. x increases to the right, and y increases to the bottom.", "id": "GoogleCloudAiplatformV1beta1SchemaVertex", "type": "object", "properties": { "x": { "format": "double", "description": "X coordinate of the vertex, normalized to [0.0, 1.0].", "type": "number" }, "y": { "format": "double", "type": "number", "description": "Y coordinate of the vertex, normalized to [0.0, 1.0]." } } }, "GoogleCloudAiplatformV1beta1MutateDeployedModelRequest": { "type": "object", "description": "Request message for EndpointService.MutateDeployedModel.", "properties": { "deployedModel": { "description": "Required. The DeployedModel to be mutated within the Endpoint. Only the following fields can be mutated: * `min_replica_count` in either DedicatedResources or AutomaticResources * `max_replica_count` in either DedicatedResources or AutomaticResources * `required_replica_count` in DedicatedResources * autoscaling_metric_specs * `disable_container_logging` (v1 only) * `enable_container_logging` (v1beta1 only) * `scale_to_zero_spec` in DedicatedResources (v1beta1 only) * `initial_replica_count` in DedicatedResources (v1beta1 only)", "$ref": "GoogleCloudAiplatformV1beta1DeployedModel" }, "updateMask": { "format": "google-fieldmask", "type": "string", "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask." } }, "id": "GoogleCloudAiplatformV1beta1MutateDeployedModelRequest" }, "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservability": { "description": "Data source for the OnlineEvaluator, based on Google Cloud Observability stack (Cloud Trace & Cloud Logging).", "properties": { "traceView": { "type": "string", "description": "Optional. Optional trace view that will be used to query traces. If empty, the `_AllSpans` view from `_Trace` US bucket will be used, i.e. `projects/{project_id}/locations/us/buckets/_Trace/datasets/Spans/views/_AllSpans`." }, "traceScope": { "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityTraceScope", "description": "Scope online evaluation to single traces." }, "openTelemetry": { "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityOpenTelemetry", "description": "Data source follows OpenTelemetry convention." }, "logView": { "type": "string", "description": "Optional. Optional log view that will be used to query logs. If empty, the project's default view (`projects/{project_id}`) will be used." }, "sessionScope": { "description": "Scope online evaluation to OTel sessions (i.e. group of traces with the same conversation ID).", "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilitySessionScope" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservability" }, "GoogleCloudAiplatformV1beta1RubricVerdict": { "type": "object", "properties": { "verdict": { "description": "Required. Outcome of the evaluation against the rubric, represented as a boolean. `true` indicates a \"Pass\", `false` indicates a \"Fail\".", "type": "boolean" }, "evaluatedRubric": { "$ref": "GoogleCloudAiplatformV1beta1Rubric", "description": "Required. The full rubric definition that was evaluated. Storing this ensures the verdict is self-contained and understandable, especially if the original rubric definition changes or was dynamically generated." }, "reasoning": { "type": "string", "description": "Optional. Human-readable reasoning or explanation for the verdict. This can include specific examples or details from the evaluated content that justify the given verdict." } }, "description": "Represents the verdict of an evaluation against a single rubric.", "id": "GoogleCloudAiplatformV1beta1RubricVerdict" }, "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequest": { "id": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequest", "properties": { "dataKeyAndFeatureValues": { "description": "Required. The data keys and associated feature values.", "items": { "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequestDataKeyAndFeatureValues" }, "type": "array" } }, "description": "Request message for FeatureOnlineStoreService.FeatureViewDirectWrite.", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation": { "properties": { "categorical": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalTransformation" }, "auto": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationAutoTransformation" }, "repeatedText": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextArrayTransformation" }, "repeatedNumeric": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericArrayTransformation" }, "numeric": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationNumericTransformation" }, "repeatedCategorical": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationCategoricalArrayTransformation" }, "text": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation" }, "timestamp": { "$ref": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTimestampTransformation" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformation" }, "GoogleCloudAiplatformV1beta1EvaluationResults": { "description": "The results of the evaluation run.", "type": "object", "id": "GoogleCloudAiplatformV1beta1EvaluationResults", "properties": { "evaluationSet": { "description": "The evaluation set where item level results are stored.", "type": "string" }, "lossAnalysisResults": { "readOnly": true, "items": { "$ref": "GoogleCloudAiplatformV1beta1LossAnalysisResult" }, "type": "array", "description": "Output only. The results of the auto-loss analysis performed on the eval set associated with the run." }, "summaryMetrics": { "description": "Optional. The summary metrics for the evaluation run.", "$ref": "GoogleCloudAiplatformV1beta1SummaryMetrics" } } }, "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsRegressionEvaluationMetrics": { "id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsRegressionEvaluationMetrics", "properties": { "meanAbsoluteError": { "type": "number", "description": "Mean Absolute Error (MAE).", "format": "float" }, "rootMeanSquaredLogError": { "format": "float", "type": "number", "description": "Root mean squared log error. Undefined when there are negative ground truth values or predictions." }, "rSquared": { "type": "number", "format": "float", "description": "Coefficient of determination as Pearson correlation coefficient. Undefined when ground truth or predictions are constant or near constant." }, "meanAbsolutePercentageError": { "type": "number", "description": "Mean absolute percentage error. Infinity when there are zeros in the ground truth.", "format": "float" }, "rootMeanSquaredError": { "description": "Root Mean Squared Error (RMSE).", "type": "number", "format": "float" } }, "type": "object", "description": "Metrics for regression evaluation results." }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation": { "description": "Training pipeline will perform following transformation functions. * The text as is--no change to case, punctuation, spelling, tense, and so on. * Tokenize text to words. Convert each words to a dictionary lookup index and generate an embedding for each index. Combine the embedding of all elements into a single embedding using the mean. * Tokenization is based on unicode script boundaries. * Missing values get their own lookup index and resulting embedding. * Stop-words receive no special treatment and are not removed.", "type": "object", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutoMlTablesInputsTransformationTextTransformation", "properties": { "columnName": { "type": "string" } } }, "GoogleCloudAiplatformV1beta1AskContextsResponse": { "properties": { "response": { "description": "The Retrieval Response.", "type": "string" }, "contexts": { "$ref": "GoogleCloudAiplatformV1beta1RagContexts", "description": "The contexts of the query." } }, "description": "Response message for VertexRagService.AskContexts.", "id": "GoogleCloudAiplatformV1beta1AskContextsResponse", "type": "object" }, "GoogleCloudAiplatformV1beta1RagFile": { "properties": { "jiraSource": { "description": "The RagFile is imported from a Jira query.", "$ref": "GoogleCloudAiplatformV1beta1JiraSource" }, "name": { "type": "string", "description": "Output only. The resource name of the RagFile.", "readOnly": true }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Timestamp when this RagFile was created.", "type": "string" }, "ragFileType": { "readOnly": true, "type": "string", "description": "Output only. The type of the RagFile.", "enumDescriptions": [ "RagFile type is unspecified.", "RagFile type is TXT.", "RagFile type is PDF." ], "enum": [ "RAG_FILE_TYPE_UNSPECIFIED", "RAG_FILE_TYPE_TXT", "RAG_FILE_TYPE_PDF" ] }, "directUploadSource": { "readOnly": true, "description": "Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request.", "$ref": "GoogleCloudAiplatformV1beta1DirectUploadSource" }, "googleDriveSource": { "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1GoogleDriveSource", "description": "Output only. Google Drive location. Supports importing individual files as well as Google Drive folders." }, "gcsSource": { "$ref": "GoogleCloudAiplatformV1beta1GcsSource", "description": "Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the Cloud Storage uri for now.", "readOnly": true }, "displayName": { "type": "string", "description": "Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters." }, "userMetadata": { "readOnly": true, "description": "Output only. The metadata for metadata search. The user_metadata Needs to be in JSON format.", "type": "string" }, "sizeBytes": { "description": "Output only. The size of the RagFile in bytes.", "readOnly": true, "format": "int64", "type": "string" }, "slackSource": { "description": "The RagFile is imported from a Slack channel.", "$ref": "GoogleCloudAiplatformV1beta1SlackSource" }, "description": { "description": "Optional. The description of the RagFile.", "type": "string" }, "updateTime": { "type": "string", "description": "Output only. Timestamp when this RagFile was last updated.", "readOnly": true, "format": "google-datetime" }, "fileStatus": { "description": "Output only. State of the RagFile.", "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1FileStatus" }, "sharePointSources": { "$ref": "GoogleCloudAiplatformV1beta1SharePointSources", "description": "The RagFile is imported from a SharePoint source." } }, "description": "A RagFile contains user data for chunking, embedding and indexing.", "type": "object", "id": "GoogleCloudAiplatformV1beta1RagFile" }, "GoogleCloudAiplatformV1beta1EvaluationRunMetricPredefinedMetricSpec": { "type": "object", "properties": { "metricSpecName": { "type": "string", "description": "Required. The name of a pre-defined metric, such as \"instruction_following_v1\" or \"text_quality_v1\"." }, "parameters": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. The parameters needed to run the pre-defined metric." } }, "description": "Specification for a pre-defined metric.", "id": "GoogleCloudAiplatformV1beta1EvaluationRunMetricPredefinedMetricSpec" }, "CloudAiLargeModelsVisionNamedBoundingBox": { "properties": { "x2": { "type": "number", "format": "float" }, "y1": { "type": "number", "format": "float" }, "entities": { "type": "array", "items": { "type": "string" } }, "classes": { "type": "array", "items": { "type": "string" } }, "y2": { "format": "float", "type": "number" }, "x1": { "format": "float", "type": "number" }, "scores": { "items": { "type": "number", "format": "float" }, "type": "array" } }, "id": "CloudAiLargeModelsVisionNamedBoundingBox", "type": "object" }, "GoogleCloudAiplatformV1beta1ToolNameMatchInstance": { "description": "Spec for tool name match instance.", "properties": { "prediction": { "type": "string", "description": "Required. Output of the evaluated model." }, "reference": { "type": "string", "description": "Required. Ground truth used to compare against the prediction." } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ToolNameMatchInstance" }, "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveSpecFeatureAttributionSpec": { "description": "Feature attribution monitoring spec.", "type": "object", "id": "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveSpecFeatureAttributionSpec", "properties": { "features": { "description": "Feature names interested in monitoring. These should be a subset of the input feature names specified in the monitoring schema. If the field is not specified all features outlied in the monitoring schema will be used.", "items": { "type": "string" }, "type": "array" }, "defaultAlertCondition": { "description": "Default alert condition for all the features.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringAlertCondition" }, "featureAlertConditions": { "type": "object", "description": "Per feature alert condition will override default alert condition.", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringAlertCondition" } }, "batchExplanationDedicatedResources": { "description": "The config of resources used by the Model Monitoring during the batch explanation for non-AutoML models. If not set, `n1-standard-2` machine type will be used by default.", "$ref": "GoogleCloudAiplatformV1beta1BatchDedicatedResources" } } }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation": { "properties": { "columnName": { "type": "string" }, "timeFormat": { "type": "string", "description": "The format in which that time field is expressed. The time_format must either be one of: * `unix-seconds` * `unix-milliseconds` * `unix-microseconds` * `unix-nanoseconds` (for respectively number of seconds, milliseconds, microseconds and nanoseconds since start of the Unix epoch); or be written in `strftime` syntax. If time_format is not set, then the default format is RFC 3339 `date-time` format, where `time-offset` = `\"Z\"` (e.g. 1985-04-12T23:20:50.52Z)" } }, "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingInputsTransformationTimestampTransformation", "description": "Training pipeline will perform following transformation functions. * Apply the transformation functions for Numerical columns. * Determine the year, month, day,and weekday. Treat each value from the timestamp as a Categorical column. * Invalid numerical values (for example, values that fall outside of a typical timestamp range, or are extreme values) receive no special treatment and are not removed.", "type": "object" }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter": { "type": "object", "description": "A wrapper class which contains the tunable parameters in an AutoML Image training job.", "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionAutomlImageTrainingTunableParameter", "properties": { "trainerConfig": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Customizable trainer settings, used in the `model_garden_trainer`." }, "checkpointName": { "description": "Optional. An unique name of pretrained model checkpoint provided in model garden, it will be mapped to a GCS location internally.", "type": "string" }, "studySpec": { "$ref": "GoogleCloudAiplatformV1beta1StudySpec", "description": "Optioinal. StudySpec of hyperparameter tuning job. Required for `model_garden_trainer`." }, "trainerType": { "enum": [ "TRAINER_TYPE_UNSPECIFIED", "AUTOML_TRAINER", "MODEL_GARDEN_TRAINER" ], "enumDescriptions": [ "Default value.", "", "" ], "type": "string" }, "datasetConfig": { "description": "Customizable dataset settings, used in the `model_garden_trainer`.", "type": "object", "additionalProperties": { "type": "string" } } } }, "GoogleCloudAiplatformV1beta1UpdateSpecialistPoolOperationMetadata": { "description": "Runtime operation metadata for SpecialistPoolService.UpdateSpecialistPool.", "properties": { "specialistPool": { "readOnly": true, "type": "string", "description": "Output only. The name of the SpecialistPool to which the specialists are being added. Format: `projects/{project_id}/locations/{location_id}/specialistPools/{specialist_pool}`" }, "genericMetadata": { "description": "The operation generic information.", "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1UpdateSpecialistPoolOperationMetadata" }, "GoogleCloudAiplatformV1beta1InvokeRequest": { "properties": { "deployedModelId": { "type": "string", "description": "ID of the DeployedModel that serves the invoke request." }, "httpBody": { "description": "The invoke method input. Supports HTTP headers and arbitrary data payload.", "$ref": "GoogleApiHttpBody" } }, "description": "Request message for PredictionService.Invoke.", "type": "object", "id": "GoogleCloudAiplatformV1beta1InvokeRequest" }, "GoogleCloudAiplatformV1beta1FeatureViewSync": { "description": "FeatureViewSync is a representation of sync operation which copies data from data source to Feature View in Online Store.", "properties": { "satisfiesPzs": { "readOnly": true, "type": "boolean", "description": "Output only. Reserved for future use." }, "syncSummary": { "description": "Output only. Summary of the sync job.", "$ref": "GoogleCloudAiplatformV1beta1FeatureViewSyncSyncSummary", "readOnly": true }, "name": { "type": "string", "description": "Identifier. Name of the FeatureViewSync. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`" }, "runTime": { "$ref": "GoogleTypeInterval", "readOnly": true, "description": "Output only. Time when this FeatureViewSync is finished." }, "satisfiesPzi": { "readOnly": true, "type": "boolean", "description": "Output only. Reserved for future use." }, "finalStatus": { "$ref": "GoogleRpcStatus", "readOnly": true, "description": "Output only. Final status of the FeatureViewSync." }, "createTime": { "type": "string", "description": "Output only. Time when this FeatureViewSync is created. Creation of a FeatureViewSync means that the job is pending / waiting for sufficient resources but may not have started the actual data transfer yet.", "format": "google-datetime", "readOnly": true } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1FeatureViewSync" }, "GoogleCloudAiplatformV1beta1WriteTensorboardExperimentDataResponse": { "type": "object", "properties": {}, "id": "GoogleCloudAiplatformV1beta1WriteTensorboardExperimentDataResponse", "description": "Response message for TensorboardService.WriteTensorboardExperimentData." }, "GoogleCloudAiplatformV1beta1SchemaPredictPredictionVideoClassificationPredictionResult": { "properties": { "timeSegmentStart": { "type": "string", "description": "The beginning, inclusive, of the video's time segment in which the AnnotationSpec has been identified. Expressed as a number of seconds as measured from the start of the video, with fractions up to a microsecond precision, and with \"s\" appended at the end. Note that for 'segment-classification' prediction type, this equals the original 'timeSegmentStart' from the input instance, for other types it is the start of a shot or a 1 second interval respectively.", "format": "google-duration" }, "displayName": { "type": "string", "description": "The display name of the AnnotationSpec that had been identified." }, "timeSegmentEnd": { "description": "The end, exclusive, of the video's time segment in which the AnnotationSpec has been identified. Expressed as a number of seconds as measured from the start of the video, with fractions up to a microsecond precision, and with \"s\" appended at the end. Note that for 'segment-classification' prediction type, this equals the original 'timeSegmentEnd' from the input instance, for other types it is the end of a shot or a 1 second interval respectively.", "format": "google-duration", "type": "string" }, "type": { "description": "The type of the prediction. The requested types can be configured via parameters. This will be one of - segment-classification - shot-classification - one-sec-interval-classification", "type": "string" }, "confidence": { "format": "float", "description": "The Model's confidence in correction of this prediction, higher value means higher confidence.", "type": "number" }, "id": { "type": "string", "description": "The resource ID of the AnnotationSpec that had been identified." } }, "type": "object", "description": "Prediction output format for Video Classification.", "id": "GoogleCloudAiplatformV1beta1SchemaPredictPredictionVideoClassificationPredictionResult" }, "GoogleCloudAiplatformV1beta1ToolCallValidMetricValue": { "type": "object", "id": "GoogleCloudAiplatformV1beta1ToolCallValidMetricValue", "properties": { "score": { "type": "number", "readOnly": true, "format": "float", "description": "Output only. Tool call valid score." } }, "description": "Tool call valid metric value for an instance." }, "GoogleCloudAiplatformV1beta1SchemaPredictPredictionTextSentimentPredictionResult": { "id": "GoogleCloudAiplatformV1beta1SchemaPredictPredictionTextSentimentPredictionResult", "description": "Prediction output format for Text Sentiment", "type": "object", "properties": { "sentiment": { "format": "int32", "description": "The integer sentiment labels between 0 (inclusive) and sentimentMax label (inclusive), while 0 maps to the least positive sentiment and sentimentMax maps to the most positive one. The higher the score is, the more positive the sentiment in the text snippet is. Note: sentimentMax is an integer value between 1 (inclusive) and 10 (inclusive).", "type": "integer" } } }, "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityNumericPredicate": { "properties": { "comparisonOperator": { "enumDescriptions": [ "Unspecified comparison operator. This value should not be used.", "Less than.", "Less than or equal to.", "Equal to.", "Not equal to.", "Greater than or equal to.", "Greater than." ], "description": "Required. The comparison operator to apply.", "enum": [ "COMPARISON_OPERATOR_UNSPECIFIED", "LESS", "LESS_OR_EQUAL", "EQUAL", "NOT_EQUAL", "GREATER_OR_EQUAL", "GREATER" ], "type": "string" }, "value": { "description": "Required. The value to compare against.", "format": "float", "type": "number" } }, "type": "object", "description": "Defines a predicate for filtering based on a numeric value.", "id": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityNumericPredicate" }, "GoogleCloudAiplatformV1beta1RecommendSpecResponseRecommendation": { "properties": { "userQuotaState": { "type": "string", "enumDescriptions": [ "Unspecified quota state. Quota information not available.", "User has enough accelerator quota for the machine type.", "User does not have enough accelerator quota for the machine type." ], "readOnly": true, "enum": [ "QUOTA_STATE_UNSPECIFIED", "QUOTA_STATE_USER_HAS_QUOTA", "QUOTA_STATE_NO_USER_QUOTA" ], "description": "Output only. The user accelerator quota state." }, "spec": { "readOnly": true, "$ref": "GoogleCloudAiplatformV1beta1RecommendSpecResponseMachineAndModelContainerSpec", "description": "Output only. The machine and model container specs." }, "region": { "description": "The region for the deployment spec (machine).", "type": "string" } }, "description": "Recommendation of one deployment option for the given custom weights model in one region. Contains the machine and container spec, and user accelerator quota state.", "id": "GoogleCloudAiplatformV1beta1RecommendSpecResponseRecommendation", "type": "object" }, "GoogleCloudAiplatformV1beta1ImportIndexRequest": { "properties": { "config": { "description": "Required. Configuration for importing data from an external source.", "$ref": "GoogleCloudAiplatformV1beta1ImportIndexRequestConnectorConfig" }, "isCompleteOverwrite": { "description": "Optional. If true, completely replace existing index data. Must be true for streaming update indexes.", "type": "boolean" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1ImportIndexRequest", "description": "Request message for IndexService.ImportIndex." }, "GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse": { "id": "GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse", "properties": { "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results. Pass to ListReasoningEnginesRequest.page_token to obtain that page." }, "reasoningEngines": { "description": "List of ReasoningEngines in the requested page.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" }, "type": "array" } }, "description": "Response message for ReasoningEngineService.ListReasoningEngines", "type": "object" }, "GoogleCloudAiplatformV1beta1SampledShapleyAttribution": { "type": "object", "properties": { "pathCount": { "format": "int32", "type": "integer", "description": "Required. The number of feature permutations to consider when approximating the Shapley values. Valid range of its value is [1, 50], inclusively." } }, "description": "An attribution method that approximates Shapley values for features that contribute to the label being predicted. A sampling strategy is used to approximate the value rather than considering all subsets of features.", "id": "GoogleCloudAiplatformV1beta1SampledShapleyAttribution" }, "GoogleCloudAiplatformV1beta1SearchModelMonitoringAlertsRequest": { "id": "GoogleCloudAiplatformV1beta1SearchModelMonitoringAlertsRequest", "properties": { "statsName": { "description": "If non-empty, returns the alerts of this stats_name.", "type": "string" }, "modelMonitoringJob": { "type": "string", "description": "If non-empty, returns the alerts of this model monitoring job." }, "alertTimeInterval": { "description": "If non-empty, returns the alerts in this time interval.", "$ref": "GoogleTypeInterval" }, "pageSize": { "type": "integer", "format": "int32", "description": "The standard list page size." }, "objectiveType": { "description": "If non-empty, returns the alerts of this objective type. Supported monitoring objectives: `raw-feature-drift` `prediction-output-drift` `feature-attribution`", "type": "string" }, "pageToken": { "description": "A page token received from a previous ModelMonitoringService.SearchModelMonitoringAlerts call.", "type": "string" } }, "description": "Request message for ModelMonitoringService.SearchModelMonitoringAlerts.", "type": "object" }, "GenaiVertexV1beta1SafetySetting": { "description": "A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.", "properties": { "threshold": { "enumDescriptions": [ "The harm block threshold is unspecified.", "Block content with a low harm probability or higher.", "Block content with a medium harm probability or higher.", "Block content with a high harm probability.", "Do not block any content, regardless of its harm probability.", "Turn off the safety filter entirely." ], "type": "string", "description": "Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked.", "enum": [ "HARM_BLOCK_THRESHOLD_UNSPECIFIED", "BLOCK_LOW_AND_ABOVE", "BLOCK_MEDIUM_AND_ABOVE", "BLOCK_ONLY_HIGH", "BLOCK_NONE", "OFF" ] }, "type": { "description": "Required. The type of harm category to be blocked.", "enumDescriptions": [ "Default value. This value is unused.", "Content that promotes violence or incites hatred against individuals or groups based on certain attributes.", "Content that promotes, facilitates, or enables dangerous activities.", "Abusive, threatening, or content intended to bully, torment, or ridicule.", "Content that contains sexually explicit material.", "Deprecated: Election filter is not longer supported. The harm category is civic integrity.", "Images that contain hate speech.", "Images that contain dangerous content.", "Images that contain harassment.", "Images that contain sexually explicit content.", "Prompts designed to bypass safety filters." ], "enum": [ "HARM_CATEGORY_UNSPECIFIED", "HARM_CATEGORY_HATE_SPEECH", "HARM_CATEGORY_DANGEROUS_CONTENT", "HARM_CATEGORY_HARASSMENT", "HARM_CATEGORY_SEXUALLY_EXPLICIT", "HARM_CATEGORY_CIVIC_INTEGRITY", "HARM_CATEGORY_IMAGE_HATE", "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT", "HARM_CATEGORY_IMAGE_HARASSMENT", "HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT", "HARM_CATEGORY_JAILBREAK" ], "type": "string", "enumDeprecated": [ false, false, false, false, false, true, false, false, false, false, false ] }, "method": { "enum": [ "HARM_BLOCK_METHOD_UNSPECIFIED", "SEVERITY", "PROBABILITY" ], "description": "Optional. The method for blocking content. If not specified, the default behavior is to use the probability score.", "type": "string", "enumDescriptions": [ "The harm block method is unspecified.", "The harm block method uses both probability and severity scores.", "The harm block method uses the probability score." ] } }, "type": "object", "id": "GenaiVertexV1beta1SafetySetting" }, "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsVideoObjectTrackingMetrics": { "properties": { "evaluatedFrameCount": { "description": "UNIMPLEMENTED. The number of video frames used to create this evaluation.", "type": "integer", "format": "int32" }, "evaluatedTrackCount": { "description": "UNIMPLEMENTED. The total number of tracks (i.e. as seen across all frames) the ground truth used to create this evaluation had.", "format": "int32", "type": "integer" }, "trackMeanMismatchRate": { "description": "UNIMPLEMENTED. The single metric for tracking consistency evaluation: the `meanMismatchRate` averaged over all `trackMetrics`.", "format": "float", "type": "number" }, "trackMetrics": { "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsTrackMetrics" }, "description": "UNIMPLEMENTED. The tracks match metrics for each intersection-over-union threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair.", "type": "array" }, "trackMeanAveragePrecision": { "description": "UNIMPLEMENTED. The single metric for tracks accuracy evaluation: the `meanAveragePrecision` averaged over all `trackMetrics`.", "type": "number", "format": "float" }, "trackMeanBoundingBoxIou": { "format": "float", "description": "UNIMPLEMENTED. The single metric for tracks bounding box iou evaluation: the `meanBoundingBoxIou` averaged over all `trackMetrics`.", "type": "number" }, "boundingBoxMetrics": { "items": { "$ref": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsBoundingBoxMetrics" }, "type": "array", "description": "The bounding boxes match metrics for each intersection-over-union threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 and each label confidence threshold 0.05,0.10,...,0.95,0.96,0.97,0.98,0.99 pair." }, "evaluatedBoundingBoxCount": { "type": "integer", "description": "UNIMPLEMENTED. The total number of bounding boxes (i.e. summed over all frames) the ground truth used to create this evaluation had.", "format": "int32" }, "boundingBoxMeanAveragePrecision": { "type": "number", "description": "The single metric for bounding boxes evaluation: the `meanAveragePrecision` averaged over all `boundingBoxMetrics`.", "format": "float" } }, "description": "Model evaluation metrics for video object tracking problems. Evaluates prediction quality of both labeled bounding boxes and labeled tracks (i.e. series of bounding boxes sharing same label and instance ID).", "id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsVideoObjectTrackingMetrics", "type": "object" }, "GoogleCloudAiplatformV1beta1ReasoningEngineSpec": { "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpec", "properties": { "serviceAccount": { "description": "Optional. The service account that the Reasoning Engine artifact runs as. It should have \"roles/storage.objectViewer\" for reading the user project's Cloud Storage and \"roles/aiplatform.user\" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used.", "type": "string" }, "packageSpec": { "description": "Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified.", "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecPackageSpec" }, "agentCard": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "Optional. The A2A Agent Card for the agent (if available). It follows the specification at https://a2a-protocol.org/latest/specification/#5-agent-discovery-the-agent-card." }, "buildSpec": { "description": "Optional. Configuration for building container image.", "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecBuildSpec" }, "sourceCodeSpec": { "description": "Deploy from source code files with a defined entrypoint.", "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpec" }, "deploymentSpec": { "description": "Optional. The specification of a Reasoning Engine deployment.", "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec" }, "effectiveIdentity": { "type": "string", "description": "Output only. The identity to use for the Reasoning Engine. It can contain one of the following values: * service-{project}@gcp-sa-aiplatform-re.googleapis.com (for SERVICE_AGENT identity type) * {name}@{project}.gserviceaccount.com (for SERVICE_ACCOUNT identity type) * agents.global.{org}.system.id.goog/resources/aiplatform/projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine} (for AGENT_IDENTITY identity type)", "readOnly": true }, "classMethods": { "description": "Optional. Declarations for object class methods in OpenAPI specification format.", "type": "array", "items": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" } }, "identityType": { "enumDescriptions": [ "Default value. Use a custom service account if the `service_account` field is set, otherwise use the default Vertex AI Reasoning Engine Service Agent in the project. Same behavior as SERVICE_ACCOUNT.", "Use a custom service account if the `service_account` field is set, otherwise use the default Vertex AI Reasoning Engine Service Agent in the project.", "Use Agent Identity. The `service_account` field must not be set." ], "enum": [ "IDENTITY_TYPE_UNSPECIFIED", "SERVICE_ACCOUNT", "AGENT_IDENTITY" ], "description": "Optional. The identity type to use for the Reasoning Engine. If not specified, the `service_account` field will be used if set, otherwise the default Vertex AI Reasoning Engine Service Agent in the project will be used.", "type": "string" }, "containerSpec": { "description": "Deploy from a container image with a defined entrypoint and commands.", "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecContainerSpec" }, "agentFramework": { "description": "Optional. The OSS agent framework used to develop the agent. Currently supported values: \"google-adk\", \"langchain\", \"langgraph\", \"ag2\", \"llama-index\", \"custom\".", "type": "string" } }, "description": "ReasoningEngine configurations", "type": "object" }, "GoogleCloudAiplatformV1beta1ToolParameterKeyMatchMetricValue": { "id": "GoogleCloudAiplatformV1beta1ToolParameterKeyMatchMetricValue", "type": "object", "properties": { "score": { "type": "number", "readOnly": true, "description": "Output only. Tool parameter key match score.", "format": "float" } }, "description": "Tool parameter key match metric value for an instance." }, "GoogleCloudAiplatformV1beta1SearchDataItemsResponse": { "type": "object", "description": "Response message for DatasetService.SearchDataItems.", "properties": { "nextPageToken": { "type": "string", "description": "A token to retrieve next page of results. Pass to SearchDataItemsRequest.page_token to obtain that page." }, "dataItemViews": { "items": { "$ref": "GoogleCloudAiplatformV1beta1DataItemView" }, "type": "array", "description": "The DataItemViews read." } }, "id": "GoogleCloudAiplatformV1beta1SearchDataItemsResponse" }, "GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageAuto": { "deprecated": true, "properties": {}, "id": "GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageAuto", "description": "Deprecated: Use top-level `language_codes` instead. Indicates the language of the audio should be automatically detected.", "type": "object" }, "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringObjectiveConfig": { "id": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringObjectiveConfig", "properties": { "deployedModelId": { "description": "The DeployedModel ID of the objective config.", "type": "string" }, "objectiveConfig": { "description": "The objective config of for the modelmonitoring job of this deployed model.", "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveConfig" } }, "type": "object", "description": "ModelDeploymentMonitoringObjectiveConfig contains the pair of deployed_model_id to ModelMonitoringObjectiveConfig." }, "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata": { "type": "object", "description": "Model metadata specific to Seq2Seq Plus Forecasting.", "properties": { "evaluatedDataItemsBigqueryUri": { "type": "string", "description": "BigQuery destination uri for exported evaluated examples." }, "trainCostMilliNodeHours": { "description": "Output only. The actual training cost of the model, expressed in milli node hours, i.e. 1,000 value in this field means 1 node hour. Guaranteed to not exceed the train budget.", "format": "int64", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1SchemaTrainingjobDefinitionSeq2SeqPlusForecastingMetadata" }, "GoogleCloudAiplatformV1beta1ReasoningEngineTrafficConfig": { "properties": { "trafficSplitAlwaysLatest": { "description": "Optional. Traffic distribution configuration, where all traffic is sent to the latest Runtime Revision.", "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineTrafficConfigTrafficSplitAlwaysLatest" }, "trafficSplitManual": { "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineTrafficConfigTrafficSplitManual", "description": "Optional. Manual traffic distribution configuration, where the user specifies the Runtime Revision IDs and the percentage of traffic to send to each." } }, "id": "GoogleCloudAiplatformV1beta1ReasoningEngineTrafficConfig", "description": "Traffic distribution configuration.", "type": "object" }, "GoogleCloudAiplatformV1beta1AuthConfigHttpBasicAuthConfig": { "type": "object", "description": "Config for HTTP Basic Authentication.", "id": "GoogleCloudAiplatformV1beta1AuthConfigHttpBasicAuthConfig", "properties": { "credentialSecret": { "description": "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.", "type": "string" } } }, "GenaiVertexV1beta1DocumentContent": { "description": "A document content block. ", "properties": { "data": { "description": "The document content.", "format": "byte", "type": "string" }, "uri": { "description": "The URI of the document.", "type": "string" }, "mimeTypeString": { "type": "string", "description": "Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the \"mime_type\" JSON key." } }, "type": "object", "id": "GenaiVertexV1beta1DocumentContent" }, "CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity": { "properties": { "score": { "description": "Confidence score of the label", "format": "float", "type": "number" }, "iouScore": { "type": "number", "format": "float", "description": "The intersection ratio between the detection bounding box and the mask." }, "mid": { "type": "string", "description": "MID of the label" }, "description": { "description": "Description of the label", "type": "string" }, "boundingBox": { "$ref": "CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox", "description": "Bounding box of the label" } }, "description": "The properties for a detected entity from the rai signal.", "id": "CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity", "type": "object" }, "GoogleCloudAiplatformV1beta1ResourcesConsumed": { "properties": { "replicaHours": { "description": "Output only. The number of replica hours used. Note that many replicas may run in parallel, and additionally any given work may be queued for some time. Therefore this value is not strictly related to wall time.", "readOnly": true, "format": "double", "type": "number" } }, "id": "GoogleCloudAiplatformV1beta1ResourcesConsumed", "description": "Statistics information about resource consumption.", "type": "object" }, "CloudAiLargeModelsVisionImage": { "description": "Image.", "properties": { "raiInfo": { "$ref": "CloudAiLargeModelsVisionRaiInfo", "description": "RAI info for image." }, "imageRaiScores": { "description": "RAI scores for generated image.", "$ref": "CloudAiLargeModelsVisionImageRAIScores" }, "imageSize": { "description": "Image size. The size of the image. Can be self reported, or computed from the image bytes.", "$ref": "CloudAiLargeModelsVisionImageImageSize" }, "generationSeed": { "description": "Generation seed for the sampled image. This parameter is exposed to the user only if one of the following is true: 1. The user specified per-example seeds in the request. 2. The user doesn't specify the generation seed in the request.", "type": "integer", "format": "int32" }, "uri": { "description": "Path to another storage (typically Google Cloud Storage).", "type": "string" }, "encoding": { "description": "Image encoding, encoded as \"image/png\" or \"image/jpg\".", "type": "string" }, "text": { "type": "string", "description": "Text/Expanded text input for imagen." }, "semanticFilterResponse": { "$ref": "CloudAiLargeModelsVisionSemanticFilterResponse", "description": "Semantic filter info for image." }, "image": { "type": "string", "format": "byte", "description": "Raw bytes." } }, "type": "object", "id": "CloudAiLargeModelsVisionImage" }, "GoogleCloudAiplatformV1beta1GenerateContentResponsePromptFeedback": { "id": "GoogleCloudAiplatformV1beta1GenerateContentResponsePromptFeedback", "properties": { "blockReason": { "readOnly": true, "enumDescriptions": [ "The blocked reason is unspecified.", "The prompt was blocked for safety reasons.", "The prompt was blocked for other reasons. For example, it may be due to the prompt's language, or because it contains other harmful content.", "The prompt was blocked because it contains a term from the terminology blocklist.", "The prompt was blocked because it contains prohibited content.", "The prompt was blocked by Model Armor.", "The prompt was blocked because it contains content that is unsafe for image generation.", "The prompt was blocked as a jailbreak attempt." ], "type": "string", "description": "Output only. The reason why the prompt was blocked.", "enum": [ "BLOCKED_REASON_UNSPECIFIED", "SAFETY", "OTHER", "BLOCKLIST", "PROHIBITED_CONTENT", "MODEL_ARMOR", "IMAGE_SAFETY", "JAILBREAK" ] }, "safetyRatings": { "readOnly": true, "description": "Output only. A list of safety ratings for the prompt. There is one rating per category.", "items": { "$ref": "GoogleCloudAiplatformV1beta1SafetyRating" }, "type": "array" }, "blockReasonMessage": { "type": "string", "description": "Output only. A readable message that explains the reason why the prompt was blocked.", "readOnly": true } }, "type": "object", "description": "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." }, "GoogleCloudAiplatformV1beta1CancelPipelineJobRequest": { "type": "object", "properties": {}, "description": "Request message for PipelineService.CancelPipelineJob.", "id": "GoogleCloudAiplatformV1beta1CancelPipelineJobRequest" }, "GoogleCloudAiplatformV1beta1UndeployIndexResponse": { "description": "Response message for IndexEndpointService.UndeployIndex.", "properties": {}, "id": "GoogleCloudAiplatformV1beta1UndeployIndexResponse", "type": "object" }, "GoogleCloudAiplatformV1beta1QueryExtensionRequest": { "id": "GoogleCloudAiplatformV1beta1QueryExtensionRequest", "type": "object", "properties": { "contents": { "type": "array", "description": "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.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" } } }, "description": "Request message for ExtensionExecutionService.QueryExtension." }, "GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesResponse": { "properties": { "data": { "items": { "$ref": "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponse" }, "type": "array" }, "dataKeysWithError": { "items": { "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDataKey" }, "type": "array" }, "status": { "description": "Response status. If OK, then StreamingFetchFeatureValuesResponse.data will be populated. Otherwise StreamingFetchFeatureValuesResponse.data_keys_with_error will be populated with the appropriate data keys. The error only applies to the listed data keys - the stream will remain open for further FeatureOnlineStoreService.StreamingFetchFeatureValuesRequest requests.", "$ref": "GoogleRpcStatus" } }, "description": "Response message for FeatureOnlineStoreService.StreamingFetchFeatureValues.", "type": "object", "id": "GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesResponse" }, "GoogleCloudAiplatformV1beta1ExportDataRequest": { "id": "GoogleCloudAiplatformV1beta1ExportDataRequest", "description": "Request message for DatasetService.ExportData.", "type": "object", "properties": { "exportConfig": { "description": "Required. The desired output location.", "$ref": "GoogleCloudAiplatformV1beta1ExportDataConfig" } } }, "GenaiVertexV1beta1FunctionResultSubcontentList": { "type": "object", "properties": { "contents": { "type": "array", "items": { "$ref": "GenaiVertexV1beta1FunctionResultSubcontent" } } }, "id": "GenaiVertexV1beta1FunctionResultSubcontentList" }, "GoogleCloudAiplatformV1beta1GenerateUserScenariosRequest": { "properties": { "allowCrossRegionModel": { "description": "Optional. Allows the scenario generation to use cross region models. When this flag is set, the service may route traffic to other regions if a model is unavailable in the current region (e.g., to a `global` endpoint). If a fully-qualified model endpoint resource name with a different region than the request location is provided elsewhere in the request, this flag must be set to true or the request will fail.", "type": "boolean" }, "agents": { "type": "object", "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1AgentConfig" }, "description": "Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. Required unless `gemini_agent_config` is set, in which case the agents map and `root_agent_id` are derived from the referenced Gemini Agent." }, "userScenarioGenerationConfig": { "description": "Required. Configuration for generating user scenarios.", "$ref": "GoogleCloudAiplatformV1beta1UserScenarioGenerationConfig" }, "geminiAgentConfig": { "description": "Optional. Config for a Gemini Agent to generate user scenarios for.", "$ref": "GoogleCloudAiplatformV1beta1GeminiAgentConfig" }, "rootAgentId": { "description": "Optional. The agent id to identify the root agent. Required unless `gemini_agent_config` is set, in which case it is derived from the referenced Gemini Agent.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1GenerateUserScenariosRequest", "description": "Request message for DataFoundryService.GenerateUserScenarios.", "type": "object" }, "GoogleCloudAiplatformV1beta1ResumeSandboxEnvironmentRequest": { "description": "Request message for SandboxEnvironmentService.ResumeSandboxEnvironment.", "properties": {}, "id": "GoogleCloudAiplatformV1beta1ResumeSandboxEnvironmentRequest", "type": "object" }, "GoogleCloudAiplatformV1beta1TrajectorySingleToolUseMetricValue": { "type": "object", "properties": { "score": { "description": "Output only. TrajectorySingleToolUse score.", "format": "float", "type": "number", "readOnly": true } }, "id": "GoogleCloudAiplatformV1beta1TrajectorySingleToolUseMetricValue", "description": "TrajectorySingleToolUse metric value for an instance." }, "GoogleCloudAiplatformV1beta1VertexAiSearchConfig": { "properties": { "servingConfig": { "description": "Vertex AI Search Serving Config resource full name. For example, `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}` or `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}`.", "type": "string" } }, "id": "GoogleCloudAiplatformV1beta1VertexAiSearchConfig", "description": "Config for the Vertex AI Search.", "type": "object" }, "GoogleCloudAiplatformV1beta1StudySpecMedianAutomatedStoppingSpec": { "id": "GoogleCloudAiplatformV1beta1StudySpecMedianAutomatedStoppingSpec", "type": "object", "properties": { "useElapsedDuration": { "type": "boolean", "description": "True if median automated stopping rule applies on Measurement.elapsed_duration. It means that elapsed_duration field of latest measurement of current Trial is used to compute median objective value for each completed Trials." } }, "description": "The median automated stopping rule stops a pending Trial if the Trial's best objective_value is strictly below the median 'performance' of all completed Trials reported up to the Trial's last measurement. Currently, 'performance' refers to the running average of the objective values reported by the Trial in each measurement." }, "GoogleCloudAiplatformV1beta1RawOutput": { "properties": { "rawOutput": { "description": "Output only. Raw output string.", "readOnly": true, "items": { "type": "string" }, "type": "array" } }, "type": "object", "id": "GoogleCloudAiplatformV1beta1RawOutput", "description": "Raw output." }, "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateNetworkPort": { "description": "Represents a network port in a container.", "properties": { "port": { "description": "Optional. Port number to expose. This must be a valid port number, between 1 and 65535.", "type": "integer", "format": "int32" }, "protocol": { "description": "Optional. Protocol for port. Defaults to TCP if not specified.", "enumDescriptions": [ "Unspecified protocol. Defaults to TCP.", "TCP protocol.", "UDP protocol." ], "type": "string", "enum": [ "PROTOCOL_UNSPECIFIED", "TCP", "UDP" ] } }, "id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateNetworkPort", "type": "object" }, "GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecNgramSpeculation": { "id": "GoogleCloudAiplatformV1beta1SpeculativeDecodingSpecNgramSpeculation", "type": "object", "description": "N-Gram speculation works by trying to find matching tokens in the previous prompt sequence and use those as speculation for generating new tokens.", "properties": { "ngramSize": { "type": "integer", "description": "The number of last N input tokens used as ngram to search/match against the previous prompt sequence. This is equal to the N in N-Gram. The default value is 3 if not specified.", "format": "int32" } } } }, "revision": "20260831", "description": "Build, scale, govern, and optimize sophisticated agents and models.", "protocol": "rest", "baseUrl": "https://aiplatform.googleapis.com/", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." }, "https://www.googleapis.com/auth/cloud-platform.read-only": { "description": "View your data across Google Cloud services and see the email address of your Google Account" }, "https://www.googleapis.com/auth/aiplatform": { "description": "See, edit, configure, and delete your Google Cloud Vertex AI data and see the email address for your Google Account" } } } }, "canonicalName": "Aiplatform", "ownerDomain": "google.com", "mtlsRootUrl": "https://aiplatform.mtls.googleapis.com/", "fullyEncodeReservedExpansion": true, "batchPath": "batch" }